Class Driver
Represents a database driver containing all specificities for a database engine including its SQL dialect.
Constants summary
-
int|null
MAX_ALIAS_LENGTH ¶null
Properties summary
-
$_autoQuoting protected
bool
Indicates whether or not the driver is doing automatic identifier quoting for all queries
-
$_baseConfig protected
array
Base configuration that is merged into the user supplied configuration data.
-
$_config protected
array
Configuration data.
-
$_connection protected
\PDO
Instance of PDO.
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
-
_connect() protected
Establishes a connection to the database server
-
beginTransaction() public
Starts a transaction.
-
commitTransaction() public
Commits a transaction.
-
compileQuery() public
Transforms the passed query to this Driver's dialect and returns an instance of the transformed query and the full compiled SQL string.
-
connect() abstract public
Establishes a connection to the database server.
-
disableAutoQuoting() public
Disable auto quoting of identifiers in queries.
-
disableForeignKeySQL() abstract public
Get the SQL for disabling foreign keys.
-
disconnect() public
Disconnects from database server.
-
enableAutoQuoting() public
Sets whether or not this driver should automatically quote identifiers in queries.
-
enableForeignKeySQL() abstract public
Get the SQL for enabling foreign keys.
-
enabled() abstract public
Returns whether php is able to use this driver for connecting to database.
-
getConnection() public
Get the internal PDO connection instance.
-
getMaxAliasLength() public
Returns the maximum alias length allowed.
-
isAutoQuotingEnabled() public
Returns whether or not this driver should automatically quote identifiers in queries.
-
isConnected() public
Checks whether or not the driver is connected.
-
lastInsertId() public
Returns last id generated for a table or sequence in database.
-
newCompiler() public
Returns an instance of a QueryCompiler.
-
newTableSchema() public
Constructs new TableSchema.
-
prepare() public
Prepares a sql statement to be executed.
-
queryTranslator() abstract public
Returns a callable function that will be used to transform a passed Query object.
-
quote() public
Returns a value in a safe representation to be used in a query string
-
quoteIdentifier() abstract public
Quotes a database identifier (a column name, table name, etc..) to be used safely in queries without the risk of using reserved words.
-
releaseSavePointSQL() abstract public
Get the SQL for releasing a save point.
-
rollbackSavePointSQL() abstract public
Get the SQL for rollingback a save point.
-
rollbackTransaction() public
Rollbacks a transaction.
-
savePointSQL() abstract public
Get the SQL for creating a save point.
-
schema() public
Returns the schema name that's being used.
-
schemaDialect() abstract public
Get the schema dialect.
-
schemaValue() public
Escapes values for use in schema definitions.
-
setConnection() public
Set the internal PDO connection instance.
-
supportsDynamicConstraints() abstract public
Returns whether the driver supports adding or dropping constraints to already created tables.
-
supportsQuoting() public
Checks if the driver supports quoting, as PDO_ODBC does not support it.
-
supportsSavePoints() public
Returns whether this driver supports save points for nested transactions.
Method Detail
__construct() public ¶
__construct(array $config)
Constructor
Parameters
-
array
$config optional The configuration for the driver.
Throws
InvalidArgumentException
__debugInfo() public ¶
__debugInfo()
Returns an array that can be used to describe the internal state of this object.
Returns
array
_connect() protected ¶
_connect(string $dsn, array $config)
Establishes a connection to the database server
Parameters
-
string
$dsn A Driver-specific PDO-DSN
-
array
$config configuration to be used for creating connection
Returns
bool
true on success
beginTransaction() public ¶
beginTransaction()
Starts a transaction.
Returns
bool
True on success, false otherwise.
commitTransaction() public ¶
commitTransaction()
Commits a transaction.
Returns
bool
True on success, false otherwise.
compileQuery() public ¶
compileQuery(\Cake\Database\Query $query, \Cake\Database\ValueBinder $generator)
Transforms the passed query to this Driver's dialect and returns an instance of the transformed query and the full compiled SQL string.
Parameters
-
\Cake\Database\Query
$query The query to compile.
-
\Cake\Database\ValueBinder
$generator The value binder to use.
Returns
array
containing 2 entries. The first entity is the transformed query and the second one the compiled SQL.
connect() abstract public ¶
connect()
Establishes a connection to the database server.
Returns
bool
True on success, false on failure.
Throws
Cake\Database\Exception\MissingConnectionException
If database connection could not be established.
disableAutoQuoting() public ¶
disableAutoQuoting()
Disable auto quoting of identifiers in queries.
Returns
$this
disableForeignKeySQL() abstract public ¶
disableForeignKeySQL()
Get the SQL for disabling foreign keys.
Returns
string
enableAutoQuoting() public ¶
enableAutoQuoting(bool $enable)
Sets whether or not this driver should automatically quote identifiers in queries.
Parameters
-
bool
$enable optional Whether to enable auto quoting
Returns
$this
enableForeignKeySQL() abstract public ¶
enableForeignKeySQL()
Get the SQL for enabling foreign keys.
Returns
string
enabled() abstract public ¶
enabled()
Returns whether php is able to use this driver for connecting to database.
Returns
bool
True if it is valid to use this driver.
getMaxAliasLength() public ¶
getMaxAliasLength()
Returns the maximum alias length allowed.
This can be different than the maximum identifier length for columns.
Returns
int|null
Maximum alias length or null if no limit
isAutoQuotingEnabled() public ¶
isAutoQuotingEnabled()
Returns whether or not this driver should automatically quote identifiers in queries.
Returns
bool
lastInsertId() public ¶
lastInsertId(?string $table, ?string $column)
Returns last id generated for a table or sequence in database.
Parameters
-
string|null
$table optional table name or sequence to get last insert value from.
-
string|null
$column optional the name of the column representing the primary key.
Returns
string|int
newCompiler() public ¶
newCompiler()
Returns an instance of a QueryCompiler.
Returns
\Cake\Database\QueryCompiler
newTableSchema() public ¶
newTableSchema(string $table, array $columns)
Constructs new TableSchema.
Parameters
-
string
$table The table name.
-
array
$columns optional The list of columns for the schema.
Returns
\Cake\Database\Schema\TableSchema
prepare() public ¶
prepare(mixed $query)
Prepares a sql statement to be executed.
Parameters
-
string|\Cake\Database\Query
$query The query to turn into a prepared statement.
Returns
\Cake\Database\StatementInterface
queryTranslator() abstract public ¶
queryTranslator(string $type)
Returns a callable function that will be used to transform a passed Query object.
This function, in turn, will return an instance of a Query object that has been transformed to accommodate any specificities of the SQL dialect in use.
Parameters
-
string
$type The type of query to be transformed (select, insert, update, delete).
Returns
\Closure
quote() public ¶
quote(mixed $value, mixed $type)
Returns a value in a safe representation to be used in a query string
Parameters
-
mixed
$value The value to quote.
-
int
$type optional Type to be used for determining kind of quoting to perform.
Returns
string
quoteIdentifier() abstract public ¶
quoteIdentifier(string $identifier)
Quotes a database identifier (a column name, table name, etc..) to be used safely in queries without the risk of using reserved words.
Parameters
-
string
$identifier The identifier expression to quote.
Returns
string
releaseSavePointSQL() abstract public ¶
releaseSavePointSQL(mixed $name)
Get the SQL for releasing a save point.
Parameters
-
string|int
$name The table name.
Returns
string
rollbackSavePointSQL() abstract public ¶
rollbackSavePointSQL(mixed $name)
Get the SQL for rollingback a save point.
Parameters
-
string|int
$name The table name.
Returns
string
rollbackTransaction() public ¶
rollbackTransaction()
Rollbacks a transaction.
Returns
bool
True on success, false otherwise.
savePointSQL() abstract public ¶
savePointSQL(mixed $name)
Get the SQL for creating a save point.
Parameters
-
string|int
$name The table name.
Returns
string
schemaDialect() abstract public ¶
schemaDialect()
Get the schema dialect.
Used by Cake\Database\Schema package to reflect schema and generate schema.
If all the tables that use this Driver specify their own schemas, then this may return null.
Returns
\Cake\Database\Schema\BaseSchema
schemaValue() public ¶
schemaValue(mixed $value)
Escapes values for use in schema definitions.
Parameters
-
mixed
$value The value to escape.
Returns
string
String for use in schema definitions.
setConnection() public ¶
setConnection(mixed $connection)
Set the internal PDO connection instance.
Parameters
-
\PDO
$connection PDO instance.
Returns
$this
supportsDynamicConstraints() abstract public ¶
supportsDynamicConstraints()
Returns whether the driver supports adding or dropping constraints to already created tables.
Returns
bool
True if driver supports dynamic constraints.
supportsQuoting() public ¶
supportsQuoting()
Checks if the driver supports quoting, as PDO_ODBC does not support it.
Returns
bool
supportsSavePoints() public ¶
supportsSavePoints()
Returns whether this driver supports save points for nested transactions.
Returns
bool
True if save points are supported, false otherwise.