Class Driver

Represents a database driver containing all specificities for a database engine including its SQL dialect.

Cake\Database\Driver implements Cake\Database\DriverInterface

Direct Subclasses

Abstract
Namespace: Cake\Database
Location: Database/Driver.php

Properties summary

  • $_autoQuoting protected
    boolean

    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|null
    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
  • autoQuoting() public deprecated

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

  • Starts a transaction.
  • Commits a transaction.

  • 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.
  • connection() public deprecated

    Returns correct connection resource or object that is internally used If first argument is passed, it will set internal connection object or result to the value passed.

  • disableForeignKeySQL() abstract public
    Get the SQL for disabling foreign keys.
  • disconnect() public
    Disconnects from database server.

  • 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.
  • Get the internal PDO connection instance.

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

  • isConnected() public
    Checks whether or not the driver is connected.
  • Returns last id generated for a table or sequence in database.
  • newCompiler() public
    Returns an instance of a QueryCompiler.
  • 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. 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.

  • 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.
  • 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.
  • Set the internal PDO connection instance.

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

  • Checks if the driver supports quoting, as PDO_ODBC does not support it.
  • Returns whether this driver supports save points for nested transactions.

Method Detail

__construct()source public 

__construct( array $config = [] )

Constructor

Parameters

array $config optional []
The configuration for the driver.

Throws

InvalidArgumentException

__debugInfo()source public 

__debugInfo( )

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

Returns

array

__destruct()source public 

__destruct( )

Destructor

_connect()source 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

boolean
true on success

autoQuoting()source public deprecated 

autoQuoting( boolean|null $enable = null )

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

If called with a boolean argument, it will toggle the auto quoting setting to the passed value

Deprecated

3.4.0 use enableAutoQuoting()/isAutoQuotingEnabled() instead.

Parameters

boolean|null $enable optional null
Whether to enable auto quoting

Returns

boolean

beginTransaction()source public 

beginTransaction( )

Starts a transaction.

Returns

boolean
True on success, false otherwise.

Implementation of

Cake\Database\DriverInterface::beginTransaction()

commitTransaction()source public 

commitTransaction( )

Commits a transaction.

Returns

boolean
True on success, false otherwise.

Implementation of

Cake\Database\DriverInterface::commitTransaction()

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.


Implementation of

Cake\Database\DriverInterface::compileQuery()

connect()source abstract public 

connect( )

Establishes a connection to the database server.

Returns

boolean
True on success, false on failure.

Implementation of

Cake\Database\DriverInterface::connect()

connection()source public deprecated 

connection( mixed $connection = null )

Returns correct connection resource or object that is internally used If first argument is passed, it will set internal connection object or result to the value passed.

Deprecated

3.6.0 Use getConnection()/setConnection() instead.

Parameters

mixed $connection optional null
The PDO connection instance.

Returns

mixed
Connection object used internally.

disableForeignKeySQL()source abstract public 

disableForeignKeySQL( )

Get the SQL for disabling foreign keys.

Returns

string

Implementation of

Cake\Database\DriverInterface::disableForeignKeySQL()

disconnect()source public 

disconnect( )

Disconnects from database server.

Implementation of

Cake\Database\DriverInterface::disconnect()

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

Implementation of

Cake\Database\DriverInterface::enableAutoQuoting()

enableForeignKeySQL()source abstract public 

enableForeignKeySQL( )

Get the SQL for enabling foreign keys.

Returns

string

Implementation of

Cake\Database\DriverInterface::enableForeignKeySQL()

enabled()source abstract 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.

Implementation of

Cake\Database\DriverInterface::enabled()

getConnection()source public 

getConnection( )

Get the internal PDO connection instance.

Returns

PDO

Implementation of

Cake\Database\DriverInterface::getConnection()

isAutoQuotingEnabled()source public 

isAutoQuotingEnabled( )

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

Returns

boolean

Implementation of

Cake\Database\DriverInterface::isAutoQuotingEnabled()

isConnected()source public 

isConnected( )

Checks whether or not the driver is connected.

Returns

boolean

Implementation of

Cake\Database\DriverInterface::isConnected()

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

Implementation of

Cake\Database\DriverInterface::lastInsertId()

newCompiler()source public 

newCompiler( )

Returns an instance of a QueryCompiler.

Returns

Cake\Database\QueryCompiler

Implementation of

Cake\Database\DriverInterface::newCompiler()

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

Implementation of

Cake\Database\DriverInterface::prepare()

queryTranslator()source 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

callable

Implementation of

Cake\Database\DriverInterface::queryTranslator()

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

Implementation of

Cake\Database\DriverInterface::quote()

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

Implementation of

Cake\Database\DriverInterface::quoteIdentifier()

releaseSavePointSQL()source abstract public 

releaseSavePointSQL( string $name )

Get the SQL for releasing a save point.

Parameters

string $name
The table name.

Returns

string

Implementation of

Cake\Database\DriverInterface::releaseSavePointSQL()

rollbackSavePointSQL()source abstract public 

rollbackSavePointSQL( string $name )

Get the SQL for rollingback a save point.

Parameters

string $name
The table name.

Returns

string

Implementation of

Cake\Database\DriverInterface::rollbackSavePointSQL()

rollbackTransaction()source public 

rollbackTransaction( )

Rollbacks a transaction.

Returns

boolean
True on success, false otherwise.

Implementation of

Cake\Database\DriverInterface::rollbackTransaction()

savePointSQL()source abstract public 

savePointSQL( string $name )

Get the SQL for creating a save point.

Parameters

string $name
The table name.

Returns

string

Implementation of

Cake\Database\DriverInterface::savePointSQL()

schema()source public 

schema( )

Returns the schema name that's being used.

Returns

string

Implementation of

Cake\Database\DriverInterface::schema()

schemaDialect()source abstract public 

schemaDialect( )

Get the schema dialect.

Returns

Cake\Database\Schema\BaseSchema

Implementation of

Cake\Database\DriverInterface::schemaDialect()

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.

Implementation of

Cake\Database\DriverInterface::schemaValue()

setConnection()source public 

setConnection( PDO $connection )

Set the internal PDO connection instance.

Parameters

PDO $connection
PDO instance.

Returns


$this

Implementation of

Cake\Database\DriverInterface::setConnection()

supportsDynamicConstraints()source abstract public 

supportsDynamicConstraints( )

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

Returns

boolean
true if driver supports dynamic constraints.

Implementation of

Cake\Database\DriverInterface::supportsDynamicConstraints()

supportsQuoting()source public 

supportsQuoting( )

Checks if the driver supports quoting, as PDO_ODBC does not support it.

Returns

boolean

Implementation of

Cake\Database\DriverInterface::supportsQuoting()

supportsSavePoints()source public 

supportsSavePoints( )

Returns whether this driver supports save points for nested transactions.

Returns

boolean
True if save points are supported, false otherwise.

Implementation of

Cake\Database\DriverInterface::supportsSavePoints()

Properties detail

$_autoQuotingsource

protected boolean

Indicates whether or not the driver is doing automatic identifier quoting for all queries

false

$_baseConfigsource

protected array

Base configuration that is merged into the user supplied configuration data.

[]

$_configsource

protected array

Configuration data.

$_connectionsource

protected PDO|null

Instance of PDO.

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.Database.Driver.html