Interface DriverInterface

beginTransaction()source public

beginTransaction( )

Starts a transaction.

Returns

boolean
True on success, false otherwise.

commitTransaction()source public

commitTransaction( )

Commits a transaction.

Returns

boolean
True on success, false otherwise.

compileQuery()source 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()source public

connect( )

Establishes a connection to the database server.

Returns

boolean
True on success, false on failure.

disableForeignKeySQL()source public

disableForeignKeySQL( )

Get the SQL for disabling foreign keys.

Returns

string

disconnect()source public

disconnect( )

Disconnects from database server.

enableAutoQuoting()source public

enableAutoQuoting( boolean $enable = true )

Sets whether or not this driver should automatically quote identifiers in queries.

Parameters

boolean $enable optional true

Whether to enable auto quoting

Returns

$this

enableForeignKeySQL()source public

enableForeignKeySQL( )

Get the SQL for enabling foreign keys.

Returns

string

enabled()source public

enabled( )

Returns whether php is able to use this driver for connecting to database.

Returns

boolean
True if it is valid to use this driver.

getConnection()source public

getConnection( )

Returns correct connection resource or object that is internally used.

Returns

object
Connection object used internally.

isAutoQuotingEnabled()source public

isAutoQuotingEnabled( )

Returns whether or not this driver should automatically quote identifiers in queries.

Returns

boolean

isConnected()source public

isConnected( )

Checks whether or not the driver is connected.

Returns

boolean

lastInsertId()source public

lastInsertId( string|null $table = null , string|null $column = null )

Returns last id generated for a table or sequence in database.

Parameters

string|null $table optional null

table name or sequence to get last insert value from.

string|null $column optional null

the name of the column representing the primary key.

Returns

string|integer

newCompiler()source public

newCompiler( )

Returns an instance of a QueryCompiler.

Returns

Cake\Database\QueryCompiler

prepare()source public

prepare( string|Cake\Database\Query $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()source 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

callable

quote()source public

quote( mixed $value , string $type )

Returns a value in a safe representation to be used in a query string

Parameters

mixed $value

The value to quote.

string $type

Type to be used for determining kind of quoting to perform.

Returns

string

quoteIdentifier()source 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()source public

releaseSavePointSQL( string $name )

Get the SQL for releasing a save point.

Parameters

string $name

The table name.

Returns

string

rollbackSavePointSQL()source public

rollbackSavePointSQL( string $name )

Get the SQL for rollingback a save point.

Parameters

string $name

The table name.

Returns

string

rollbackTransaction()source public

rollbackTransaction( )

Rollbacks a transaction.

Returns

boolean
True on success, false otherwise.

savePointSQL()source public

savePointSQL( string $name )

Get the SQL for creating a save point.

Parameters

string $name

The table name.

Returns

string

schema()source public

schema( )

Returns the schema name that's being used.

Returns

string

schemaDialect()source 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()source 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()source public

setConnection( object $connection )

Set the internal connection object.

Parameters

object $connection

The connection instance.

Returns

$this

supportsDynamicConstraints()source public

supportsDynamicConstraints( )

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

Returns

boolean
true if driver supports dynamic constraints.

supportsQuoting()source public

supportsQuoting( )

Checks if the driver supports quoting.

Returns

boolean

supportsSavePoints()source public

supportsSavePoints( )

Returns whether this driver supports save points for nested transactions.

Returns

boolean
True if save points are supported, false otherwise.