Represents a database diver containing all specificities for a database engine including its SQL dialect
connect( )
Establishes a connection to the database server
boolean
enabled( )
Returns whether php is able to use this driver for connecting to database
boolean
setEncoding( string $encoding )
Sets connection encoding
$encoding
setSchema( string $schema )
Sets connection default schema, if any relation defined in a query is not fully qualified postgres will fallback to looking the relation into defined default schema
$schema
search_path
to.supportsDynamicConstraints( )
Returns whether the driver supports adding or dropping constraints to already created tables.
boolean
__construct( array $config [] )
Constructor
$config
optional [] InvalidArgumentException
__debugInfo( )
Returns an array that can be used to describe the internal state of this object.
array
autoQuoting( boolean $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
$enable
optional null boolean
beginTransaction( )
Starts a transaction
boolean
commitTransaction( )
Commits a transaction
boolean
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
Cake\Database\Query
$query
$generator
array
connection( null|PDO $connection null )
Returns correct connection resource or object that is internally used If first argument is passed,
$connection
optional null disableForeignKeySQL( )
Get the SQL for disabling foreign keys
string
enableForeignKeySQL( )
Get the SQL for enabling foreign keys
string
isConnected( )
Check whether or not the driver is connected.
boolean
lastInsertId( string $table null , string $column null )
Returns last id generated for a table or sequence in database
$table
optional null $column
optional null string|integer
newCompiler( )
Returns an instance of a QueryCompiler
Cake\Database\QueryCompiler
prepare( string|Cake\Database\Query $query )
Prepares a sql statement to be executed
Cake\Database\Query
$query
Cake\Database\StatementInterface
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.
$type
callable
quote( mixed $value , string $type )
Returns a value in a safe representation to be used in a query string
$value
$type
string
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
$identifier
string
releaseSavePointSQL( string $name )
Get the SQL for releasing a save point.
$name
string
rollbackSavePointSQL( string $name )
Get the SQL for rollingback a save point.
$name
string
rollbackTransaction( )
Rollsback a transaction
boolean
savePointSQL( string $name )
Get the SQL for creating a save point.
$name
string
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.
Cake\Database\Schema\BaseSchema
schemaValue( mixed $value )
Escapes values for use in schema definitions.
$value
string
supportsQuoting( )
Checks if the driver supports quoting
boolean
supportsSavePoints( )
Returns whether this driver supports save points for nested transactions
boolean
_connect( string $dsn , array $config )
Establishes a connection to the database server
$dsn
$config
boolean
beginTransaction( )
Starts a transaction
boolean
commitTransaction( )
Commits a transaction
boolean
connection( null|PDO $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
$connection
optional null PDO
isConnected( )
Check whether or not the driver is connected.
boolean
Cake\Database\Driver::isConnected()
lastInsertId( string|null $table null , string|null $column null )
Returns last id generated for a table or sequence in database
$table
optional null $column
optional null string|integer
Cake\Database\Driver::lastInsertId()
prepare( string|Cake\Database\Query $query )
Prepares a sql statement to be executed
Cake\Database\Query
$query
Cake\Database\StatementInterface
quote( mixed $value , string $type )
Returns a value in a safe representation to be used in a query string
$value
$type
string
rollbackTransaction( )
Rollsback a transaction
boolean
supportsQuoting( )
Checks if the driver supports quoting, as PDO_ODBC does not support it.
boolean
Cake\Database\Driver::supportsQuoting()
_expressionTranslators( )
Returns a dictionary of expressions to be transformed when compiling a Query to SQL. Array keys are method names to be called in this class
array
_insertQueryTranslator( Cake\Database\Query $query )
Modifies the original insert query to append a "RETURNING *" epilogue so that the latest insert id can be retrieved
Cake\Database\Query
$query
Cake\Database\Query
_transformDistinct( Cake\Database\Query $query )
Distinct clause needs no transformation
Cake\Database\Query
$query
Cake\Database\Query
_transformFunctionExpression( Cake\Database\Driver\FunctionExpression $expression )
Receives a FunctionExpression and changes it so that it conforms to this SQL dialect.
$expression
disableForeignKeySQL( )
enableForeignKeySQL( )
schemaDialect( )
Get the schema dialect.
Used by Cake\Database\Schema package to reflect schema and generate schema.
Cake\Database\Schema\PostgresSchema
_deleteQueryTranslator( Cake\Database\Query $query )
Apply translation steps to delete queries.
Chops out aliases on delete query conditions as most database dialects do not support aliases in delete queries. This also removes aliases in table names as they frequently don't work either.
We are intentionally not supporting deletes with joins as they have even poorer support.
Cake\Database\Query
$query
Cake\Database\Query
_selectQueryTranslator( Cake\Database\Query $query )
Apply translation steps to select queries.
Cake\Database\Query
$query
Cake\Database\Query
_updateQueryTranslator( Cake\Database\Query $query )
Apply translation steps to update queries.
Cake\Database\Query
$query
Cake\Database\Query
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.
$type
callable
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
$identifier
string
releaseSavePointSQL( string $name )
Returns a SQL snippet for releasing a previously created save point
$name
string
rollbackSavePointSQL( string $name )
Returns a SQL snippet for rollbacking a previously created save point
$name
string
savePointSQL( string $name )
Returns a SQL snippet for creating a new transaction savepoint
$name
string
protected boolean
Indicates whether or not the driver is doing automatic identifier quoting for all queries
false
protected string
String used to end a database identifier quoting to make it safe
'"'
protected Cake\Database\Schema\PostgresSchema
The schema dialect class for this driver
protected string
String used to start a database identifier quoting to make it safe
'"'
© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Database.Driver.Postgres.html