Interface DriverInterface
Interface for database driver.
Method Summary
-
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() public
Establishes a connection to the database server.
-
disableAutoQuoting() public
Disable auto quoting of identifiers in queries.
-
disableForeignKeySQL() 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() public
Get the SQL for enabling foreign keys.
-
enabled() public
Returns whether php is able to use this driver for connecting to database.
-
getConnection() public
Returns correct connection resource or object that is internally used.
-
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() 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() 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() public
Get the SQL for releasing a save point.
-
rollbackSavePointSQL() public
Get the SQL for rollingback a save point.
-
rollbackTransaction() public
Rollbacks a transaction.
-
savePointSQL() public
Get the SQL for creating a save point.
-
schema() public
Returns the schema name that's being used.
-
schemaDialect() public
Get the schema dialect.
-
schemaValue() public
Escapes values for use in schema definitions.
-
setConnection() public
Set the internal connection object.
-
supportsDynamicConstraints() public
Returns whether the driver supports adding or dropping constraints to already created tables.
-
supportsQuoting() public
Checks if the driver supports quoting.
-
supportsSavePoints() public
Returns whether this driver supports save points for nested transactions.
Method Detail
beginTransaction() public ¶
beginTransaction()
Starts a transaction.
Returns
boolTrue on success, false otherwise.
commitTransaction() public ¶
commitTransaction()
Commits a transaction.
Returns
boolTrue 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
arraycontaining 2 entries. The first entity is the transformed query and the second one the compiled SQL.
connect() public ¶
connect()
Establishes a connection to the database server.
Returns
boolTrue on success, false on failure.
Throws
Cake\Database\Exception\MissingConnectionExceptionIf database connection could not be established.
disableAutoQuoting() public ¶
disableAutoQuoting()
Disable auto quoting of identifiers in queries.
Returns
$thisdisableForeignKeySQL() public ¶
disableForeignKeySQL()
Get the SQL for disabling foreign keys.
Returns
stringenableAutoQuoting() 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
$thisenableForeignKeySQL() public ¶
enableForeignKeySQL()
Get the SQL for enabling foreign keys.
Returns
stringenabled() public ¶
enabled()
Returns whether php is able to use this driver for connecting to database.
Returns
boolTrue if it is valid to use this driver.
getConnection() public ¶
getConnection()
Returns correct connection resource or object that is internally used.
Returns
objectConnection object used internally.
isAutoQuotingEnabled() public ¶
isAutoQuotingEnabled()
Returns whether or not this driver should automatically quote identifiers in queries.
Returns
boollastInsertId() 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|intnewCompiler() public ¶
newCompiler()
Returns an instance of a QueryCompiler.
Returns
\Cake\Database\QueryCompilernewTableSchema() 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\TableSchemaprepare() 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\StatementInterfacequeryTranslator() 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
\Closurequote() 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 Type to be used for determining kind of quoting to perform.
Returns
stringquoteIdentifier() 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
stringreleaseSavePointSQL() public ¶
releaseSavePointSQL(mixed $name)
Get the SQL for releasing a save point.
Parameters
-
string|int$name The table name.
Returns
stringrollbackSavePointSQL() public ¶
rollbackSavePointSQL(mixed $name)
Get the SQL for rollingback a save point.
Parameters
-
string|int$name The table name.
Returns
stringrollbackTransaction() public ¶
rollbackTransaction()
Rollbacks a transaction.
Returns
boolTrue on success, false otherwise.
savePointSQL() public ¶
savePointSQL(mixed $name)
Get the SQL for creating a save point.
Parameters
-
string|int$name The table name.
Returns
stringschemaDialect() 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\BaseSchemaschemaValue() public ¶
schemaValue(mixed $value)
Escapes values for use in schema definitions.
Parameters
-
mixed$value The value to escape.
Returns
stringString for use in schema definitions.
setConnection() public ¶
setConnection(mixed $connection)
Set the internal connection object.
Parameters
-
object$connection The connection instance.
Returns
$thissupportsDynamicConstraints() public ¶
supportsDynamicConstraints()
Returns whether the driver supports adding or dropping constraints to already created tables.
Returns
boolTrue if driver supports dynamic constraints.
supportsSavePoints() public ¶
supportsSavePoints()
Returns whether this driver supports save points for nested transactions.
Returns
boolTrue if save points are supported, false otherwise.