Class Connection
Property Summary
-
$_client protected
Elastica\ClientElastica client instance
-
$_esLogger protected
Cake\ElasticSearch\Datasource\Log\ElasticLoggerInstance of ElasticLogger
-
$_logger protected
Cake\Database\Log\QueryLogger|Psr\Log\LoggerInterfaceLogger object instance.
-
$configName protected
stringThe connection name in the connection manager.
-
$logQueries protected
boolWhether or not query logging is enabled.
Method Summary
-
__call() public
Pass remaining methods to the elastica client (if they exist) And set the current logger based on current logQueries value
-
__construct() public
Constructor.
-
beginTransaction() public
{@inheritDoc}
-
config() public
Get the config data for this connection.
-
configName() public
Get the configuration name for this connection.
-
disableConstraints() public
Run an operation with constraints disabled.
-
disableForeignKeys() public
{@inheritDoc}
-
disableQueryLogging() public @method
-
disableSavePoints() public @method
-
enableForeignKeys() public
{@inheritDoc}
-
enableQueryLogging() public @method
-
enabled() public
{@inheritDoc}
-
execute() public @method
-
getDriver() public @method
Gets the driver instance.
-
getEsLogger() public
Return instance of ElasticLogger
-
getLogger() public
Get the logger object Will set the default logger to elasticsearch if found, or debug If none of the above are found the default Es logger will be used.
-
getSchemaCollection() public
Returns a SchemaCollection stub until we can add more abstract API's in Connection.
-
isQueryLoggingEnabled() public @method
-
logQueries() public
Enables or disables query logging for this connection.
-
logger() public deprecated
Sets the logger object instance. When called with no arguments it returns the currently setup logger instance.
-
newQuery() public @method
-
prepare() public @method
-
query() public @method
-
quote() public @method
-
setLogger() public
Sets a logger
-
supportsDynamicConstraints() public @method
-
transactional() public
Executes a callable function inside a transaction, if any exception occurs while executing the passed callable, the transaction will be rolled back If the result of the callable function is
false, the transaction will also be rolled back. Otherwise the transaction is committed after executing the callback.
Method Detail
__call() ¶ public
__call(string $name, array $attributes): mixedPass remaining methods to the elastica client (if they exist) And set the current logger based on current logQueries value
Parameters
-
string$name Method name
-
array$attributes Method attributes
Returns
mixed__construct() ¶ public
__construct(array $config = [], callable $callback = null)Constructor.
Parameters
-
array$config optional config options
-
callable$callback optional Callback function which can be used to be notified about errors (for example connection down)
configName() ¶ public
configName(): stringGet the configuration name for this connection.
Returns
stringdisableConstraints() ¶ public
disableConstraints(callable $operation): mixedRun an operation with constraints disabled.
Elasticsearch does not deal with the concept of foreign key constraints This method just triggers the $operation argument.
Parameters
-
callable$operation
Returns
mixedenableQueryLogging() ¶ public @method
enableQueryLogging(mixed $value): $thisParameters
-
$value
Returns
$thisexecute() ¶ public @method
execute(mixed $query, mixed $params = [], array $types = []): Cake\Database\StatementInterfaceParameters
-
$query -
$params optional -
array$types optional
Returns
Cake\Database\StatementInterfacegetEsLogger() ¶ public
getEsLogger(): Cake\ElasticSearch\Datasource\Log\ElasticLoggerReturn instance of ElasticLogger
Returns
Cake\ElasticSearch\Datasource\Log\ElasticLoggergetLogger() ¶ public
getLogger(): Cake\Database\Log\QueryLoggerGet the logger object Will set the default logger to elasticsearch if found, or debug If none of the above are found the default Es logger will be used.
Returns
Cake\Database\Log\QueryLoggergetSchemaCollection() ¶ public
getSchemaCollection(): Cake\ElasticSearch\Datasource\SchemaCollectionReturns a SchemaCollection stub until we can add more abstract API's in Connection.
Returns
Cake\ElasticSearch\Datasource\SchemaCollectionlogQueries() ¶ public
logQueries(bool|null $enable = null): boolEnables or disables query logging for this connection.
Parameters
-
bool|null$enable optional
Returns
boollogger() ¶ public
logger(object|null $instance = null): objectSets the logger object instance. When called with no arguments it returns the currently setup logger instance.
Parameters
-
object|null$instance optional
Returns
objectprepare() ¶ public @method
prepare(mixed $sql): Cake\Database\StatementInterfaceParameters
-
$sql
Returns
Cake\Database\StatementInterfacequery() ¶ public @method
query(string $sql): Cake\Database\StatementInterfaceParameters
-
string$sql
Returns
Cake\Database\StatementInterfacequote() ¶ public @method
quote(mixed $value, mixed $type = null): stringParameters
-
$value -
$type optional
Returns
stringsetLogger() ¶ public
setLogger(mixed $logger): $thisSets a logger
Parameters
-
$logger Logger instance
Returns
$thistransactional() ¶ public
transactional(callable $transaction): mixedExecutes a callable function inside a transaction, if any exception occurs
while executing the passed callable, the transaction will be rolled back
If the result of the callable function is false, the transaction will
also be rolled back. Otherwise the transaction is committed after executing
the callback.
The callback will receive the connection instance as its first argument.
Parameters
-
callable$transaction
Returns
mixed