$_config
$_config : array
Contains the configuration params for this connection.
Represents a connection with a database server.
$_driver : \Cake\Database\Driver
Driver object, responsible for creating the real connection and provide specific SQL dialect.
$_logger : \Cake\Database\Log\QueryLogger|null
Logger object instance.
$_schemaCollection : \Cake\Database\Schema\Collection|null
The schema collection object
$nestedTransactionRollbackException : \Cake\Database\Exception\NestedTransactionRollbackException|null
NestedTransactionRollbackException object instance, will be stored if the rollback method is called in some nested transaction.
cast(mixed $value, \Cake\Database\Type|string $type) : array
Converts a give value to a suitable database value based on type and return relevant internal statement type
| mixed | $value | The value to cast |
| \Cake\Database\Type|string | $type | The type name or type instance to use. |
list containing converted value and internal type
matchTypes(array $columns, array $types) : array
Matches columns to corresponding types
Both $columns and $types should either be numeric based or string key based at the same time.
| array | $columns | list or associative array of columns and parameters to be bound with types |
| array | $types | list or associative array of types |
setDriver(\Cake\Database\Driver|string $driver, array $config = array()) : $this
Sets the driver instance. If a string is passed it will be treated as a class name and will be instantiated.
| \Cake\Database\Driver|string | $driver | The driver instance to use. |
| array | $config | Config for a new driver. |
When a driver class is missing.
When a driver's PHP extension is missing.
getDisconnectRetry() : \Cake\Core\Retry\CommandRetry
Get the retry wrapper object that is allows recovery from server disconnects while performing certain database actions, such as executing a query.
The retry wrapper
getDriver() : \Cake\Database\Driver
Gets the driver instance.
driver(\Cake\Database\Driver|string|null $driver = null, array $config = array()) : \Cake\Database\Driver
Sets the driver instance. If a string is passed it will be treated as a class name and will be instantiated.
If no params are passed it will return the current driver instance.
| \Cake\Database\Driver|string|null | $driver | The driver instance to use. |
| array | $config | Either config for a new driver or null. |
When a driver class is missing.
When a driver's PHP extension is missing.
prepare(string|\Cake\Database\Query $sql) : \Cake\Database\StatementInterface
Prepares a SQL statement to be executed.
| string|\Cake\Database\Query | $sql | The SQL to convert into a prepared statement. |
execute(string $query, array $params = array(), array $types = array()) : \Cake\Database\StatementInterface
Executes a query using $params for interpolating values and $types as a hint for each those params.
| string | $query | SQL to be executed and interpolated with $params |
| array | $params | list or associative array of params to be interpolated in $query as values |
| array | $types | list or associative array of types to be used for casting values in query |
executed statement
compileQuery(\Cake\Database\Query $query, \Cake\Database\ValueBinder $generator) : string
Compiles a Query object into a SQL string according to the dialect for this connection's driver
| \Cake\Database\Query | $query | The query to be compiled |
| \Cake\Database\ValueBinder | $generator | The placeholder generator to use |
run(\Cake\Database\Query $query) : \Cake\Database\StatementInterface
Executes the provided query after compiling it for the specific driver dialect and returns the executed Statement object.
| \Cake\Database\Query | $query | The query to be executed |
executed statement
query(string $sql) : \Cake\Database\StatementInterface
Executes a SQL statement and returns the Statement object as result.
| string | $sql | The SQL query to execute. |
newQuery() : \Cake\Database\Query
Create a new Query instance for this connection.
setSchemaCollection(\Cake\Database\Schema\Collection $collection) : $this
Sets a Schema\Collection object for this connection.
| \Cake\Database\Schema\Collection | $collection | The schema collection object |
getSchemaCollection() : \Cake\Database\Schema\Collection
Gets a Schema\Collection object for this connection.
schemaCollection(\Cake\Database\Schema\Collection|null $collection = null) : \Cake\Database\Schema\Collection
Gets or sets a Schema\Collection object for this connection.
| \Cake\Database\Schema\Collection|null | $collection | The schema collection object |
insert(string $table, array $data, array $types = array()) : \Cake\Database\StatementInterface
Executes an INSERT query on the specified table.
| string | $table | the table to insert values in |
| array | $data | values to be inserted |
| array | $types | list of associative array containing the types to be used for casting |
update(string $table, array $data, array $conditions = array(), array $types = array()) : \Cake\Database\StatementInterface
Executes an UPDATE statement on the specified table.
| string | $table | the table to update rows from |
| array | $data | values to be updated |
| array | $conditions | conditions to be set for update statement |
| array | $types | list of associative array containing the types to be used for casting |
delete(string $table, array $conditions = array(), array $types = array()) : \Cake\Database\StatementInterface
Executes a DELETE statement on the specified table.
| string | $table | the table to delete rows from |
| array | $conditions | conditions to be set for delete statement |
| array | $types | list of associative array containing the types to be used for casting |
enableSavePoints(boolean $enable) : $this
Enables/disables the usage of savepoints, enables only if driver the allows it.
If you are trying to enable this feature, make sure you check the return value of this function to verify it was enabled successfully.
$connection->enableSavePoints(true) Returns true if drivers supports save points, false otherwise
$connection->enableSavePoints(false) Disables usage of savepoints and returns false
| boolean | $enable | Whether or not save points should be used. |
useSavePoints(boolean|null $enable = null) : boolean
Returns whether this connection is using savepoints for nested transactions If a boolean is passed as argument it will enable/disable the usage of savepoints only if driver the allows it.
If you are trying to enable this feature, make sure you check the return value of this function to verify it was enabled successfully.
$connection->useSavePoints(true) Returns true if drivers supports save points, false otherwise
$connection->useSavePoints(false) Disables usage of savepoints and returns false
$connection->useSavePoints() Returns current status
| boolean|null | $enable | Whether or not save points should be used. |
true if enabled, false otherwise
transactional(callable $callback) : mixed
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.
$connection->transactional(function ($connection) {
$connection->newQuery()->delete('users')->execute();
});| callable | $callback |
The return value of the callback.
disableConstraints(callable $callback) : mixed
Run an operation with constraints disabled.
$connection->disableConstraints(function ($connection) {
$connection->newQuery()->delete('users')->execute();
});| callable | $callback |
The return value of the callback.
cacheMetadata(boolean|string $cache) : void
Enables or disables metadata caching for this connection
Changing this setting will not modify existing schema collections objects.
| boolean|string | $cache | Either boolean false to disable metadata caching, or
true to use |
setLogger(\Cake\Database\Log\QueryLogger $logger) : $this
Sets a logger
| \Cake\Database\Log\QueryLogger | $logger | Logger object |
getLogger() : \Cake\Database\Log\QueryLogger
Gets the logger object
logger instance
_newLogger(\Cake\Database\StatementInterface $statement) : \Cake\Database\Log\LoggingStatement
Returns a new statement object that will log the activity for the passed original statement instance.
| \Cake\Database\StatementInterface | $statement | the instance to be decorated |