W3cubDocs

/CakePHP 3.4

Class Driver

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

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.

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

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

  • beginTransaction() abstract public
    Starts a transaction
  • commitTransaction() abstract public
    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() abstract public

    Returns correct connection resource or object that is internally used If first argument is passed,

  • disableForeignKeySQL() abstract public
    Get the SQL for disabling foreign keys
  • disconnect() abstract 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
  • Returns whether or not this driver should automatically quote identifiers in queries

  • isConnected() public
    Check 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() abstract 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() abstract 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() abstract public
    Rollsback 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.
  • Returns whether the driver supports adding or dropping constraints to already created tables.

  • Checks if the driver supports quoting
  • 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

autoQuoting()source public

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 abstract public

beginTransaction( )

Starts a transaction

Returns

boolean
true on success, false otherwise

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

connect( )

Establishes a connection to the database server

Returns

boolean
true con success

connection()source abstract public

connection( null|PDO $connection null )

Returns correct connection resource or object that is internally used If first argument is passed,

Parameters

null|PDO $connection optional null
The connection object

Returns

Cake\Database\Connection

disableForeignKeySQL()source abstract public

disableForeignKeySQL( )

Get the SQL for disabling foreign keys

Returns

string

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

enableForeignKeySQL( )

Get the SQL for enabling foreign keys

Returns

string

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

isAutoQuotingEnabled()source public

isAutoQuotingEnabled( )

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

Returns

boolean

isConnected()source public

isConnected( )

Check 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 abstract public

prepare( string|Cake\Database\Query $query )

Prepares a sql statement to be executed

Parameters

string|Cake\Database\Query $query
The query to convert into a statement.

Returns

Cake\Database\StatementInterface

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

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

releaseSavePointSQL( string $name )

Get the SQL for releasing a save point.

Parameters

string $name
The table name

Returns

string

rollbackSavePointSQL()source abstract public

rollbackSavePointSQL( string $name )

Get the SQL for rollingback a save point.

Parameters

string $name
The table name

Returns

string

rollbackTransaction()source abstract public

rollbackTransaction( )

Rollsback a transaction

Returns

boolean
true on success, false otherwise

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

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

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

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.

© 2005–2017 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.4/class-Cake.Database.Driver.html