Class Connection

Properties summary

• $_config protected
  array
  Contains the configuration params for this connection.
• $_driver protected
  Cake\Database\Driver

  Driver object, responsible for creating the real connection and provide specific SQL dialect.

• $_logQueries protected
  boolean
  Whether to log queries generated during this connection.
• $_logger protected
  Cake\Database\Log\QueryLogger|null
  Logger object instance.
• $_schemaCollection protected
  Cake\Database\Schema\Collection|null
  The schema collection object
• $_transactionLevel protected
  integer
  Contains how many nested transactions have been started.
• $_transactionStarted protected
  boolean
  Whether a transaction is active in this connection.
• $_useSavePoints protected
  boolean

  Whether this connection can and should use savepoints for nested transactions.

• $nestedTransactionRollbackException protected
  Cake\Database\Exception\NestedTransactionRollbackException|null

  NestedTransactionRollbackException object instance, will be stored if the rollback method is called in some nested transaction.

Method Summary

• __construct() public

  Constructor.

• __debugInfo() public

  Returns an array that can be used to describe the internal state of this object.

• __destruct() public

  Destructor

• _newLogger() protected

  Returns a new statement object that will log the activity for the passed original statement instance.

• begin() public

  Starts a new transaction.

• cacheMetadata() public

  Enables or disables metadata caching for this connection

• commit() public

  Commits current transaction.

• compileQuery() public

  Compiles a Query object into a SQL string according to the dialect for this connection's driver

• config() public

  Get the configuration data used to create the connection.

• configName() public

  Get the configuration name for this connection.

• connect() public

  Connects to the configured database.

• createSavePoint() public

  Creates a new save point for nested transactions.

• delete() public

  Executes a DELETE statement on the specified table.

• disableConstraints() public

  Run an operation with constraints disabled.

• disableForeignKeys() public

  Run driver specific SQL to disable foreign key checks.

• disableQueryLogging() public

  Disable query logging

• disableSavePoints() public

  Disables the usage of savepoints.

• disconnect() public

  Disconnects from database server.

• driver() public deprecated

  Sets the driver instance. If a string is passed it will be treated as a class name and will be instantiated.

• enableForeignKeys() public

  Run driver specific SQL to enable foreign key checks.

• enableQueryLogging() public

  Enable/disable query logging

• enableSavePoints() public

  Enables/disables the usage of savepoints, enables only if driver the allows it.

• execute() public

  Executes a query using $params for interpolating values and $types as a hint for each those params.

• getDisconnectRetry() public

  Get the retry wrapper object that is allows recovery from server disconnects while performing certain database actions, such as executing a query.

• getDriver() public

  Gets the driver instance.

• getLogger() public

  Gets the logger object

• getSchemaCollection() public

  Gets a Schema\Collection object for this connection.

• inTransaction() public

  Checks if a transaction is running.

• insert() public

  Executes an INSERT query on the specified table.

• isConnected() public

  Returns whether connection to database server was already established.

• isQueryLoggingEnabled() public

  Check if query logging is enabled.

• isSavePointsEnabled() public

  Returns whether this connection is using savepoints for nested transactions

• log() public

  Logs a Query string using the configured logger object.

• logQueries() public deprecated

  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

  Create a new Query instance for this connection.

• prepare() public

  Prepares a SQL statement to be executed.

• query() public

  Executes a SQL statement and returns the Statement object as result.

• quote() public

  Quotes value to be used safely in database query.

• quoteIdentifier() public

  Quotes a database identifier (a column name, table name, etc..) to be used safely in queries without the risk of using reserved words.

• releaseSavePoint() public

  Releases a save point by its name.

• rollback() public

  Rollback current transaction.

• rollbackSavepoint() public

  Rollback a save point by its name.

• run() public

  Executes the provided query after compiling it for the specific driver dialect and returns the executed Statement object.

• schemaCollection() public deprecated

  Gets or sets a Schema\Collection object for this connection.

• setDriver() public

  Sets the driver instance. If a string is passed it will be treated as a class name and will be instantiated.

• setLogger() public

  Sets a logger

• setSchemaCollection() public

  Sets a Schema\Collection object for this connection.

• supportsDynamicConstraints() public

  Returns whether the driver supports adding or dropping constraints to already created tables.

• supportsQuoting() public

  Checks if the driver supports quoting.

• 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.

• update() public

  Executes an UPDATE statement on the specified table.

• useSavePoints() public deprecated

  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.

• wasNestedTransactionRolledback() protected

  Returns whether some nested transaction has been already rolled back.

Method Detail

$connection->disableConstraints(function ($connection) {
  $connection->newQuery()->delete('users')->execute();
});

$connection->transactional(function ($connection) {
  $connection->newQuery()->delete('users')->execute();
});

Methods used from Cake\Database\TypeConverterTrait

Magic methods inherited from Cake\Datasource\ConnectionInterface

Properties detail

false

false

false