Represents a database driver containing all specificities for a database engine including its SQL dialect.
$_baseConfig
protected array
_autoQuoting
, _config
, _connection
_endQuote
, _schemaDialect
, _startQuote
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
Returns whether the driver supports adding or dropping constraints to already created tables.
connect( )
Establishes a connection to the database server
enabled( )
Returns whether php is able to use this driver for connecting to database
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.
__construct( array $config [] )
Constructor
$config
optional [] __debugInfo( )
Returns an array that can be used to describe the internal state of this object.
_connect( string $dsn , array $config )
Establishes a connection to the database server
$dsn
$config
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
$enable
optional null beginTransaction( )
Starts a transaction.
Cake\Database\DriverInterface::beginTransaction()
commitTransaction( )
Commits a transaction.
Cake\Database\DriverInterface::commitTransaction()
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
containing 2 entries. The first entity is the transformed query and the second one the compiled SQL.
Cake\Database\DriverInterface::compileQuery()
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.
$connection
optional null disableForeignKeySQL( )
Get the SQL for disabling foreign keys.
Cake\Database\DriverInterface::disableForeignKeySQL()
disconnect( )
Disconnects from database server.
Cake\Database\DriverInterface::disconnect()
enableAutoQuoting( boolean $enable true )
Sets whether or not this driver should automatically quote identifiers in queries.
$enable
optional true Cake\Database\DriverInterface::enableAutoQuoting()
enableForeignKeySQL( )
Get the SQL for enabling foreign keys.
Cake\Database\DriverInterface::enableForeignKeySQL()
getConnection( )
Get the internal PDO connection instance.
Cake\Database\DriverInterface::getConnection()
isAutoQuotingEnabled( )
Returns whether or not this driver should automatically quote identifiers in queries.
Cake\Database\DriverInterface::isAutoQuotingEnabled()
isConnected( )
Checks whether or not the driver is connected.
Cake\Database\DriverInterface::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 Cake\Database\DriverInterface::lastInsertId()
newCompiler( )
Returns an instance of a QueryCompiler.
Cake\Database\DriverInterface::newCompiler()
prepare( string|Cake\Database\Query $query )
Prepares a sql statement to be executed.
Cake\Database\Query
$query
Cake\Database\StatementInterface
Cake\Database\DriverInterface::prepare()
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
The type of query to be transformed (select, insert, update, delete).
Cake\Database\DriverInterface::queryTranslator()
quote( mixed $value , string $type )
Returns a value in a safe representation to be used in a query string
$value
$type
Cake\Database\DriverInterface::quote()
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
Cake\Database\DriverInterface::quoteIdentifier()
releaseSavePointSQL( string $name )
Get the SQL for releasing a save point.
$name
Cake\Database\DriverInterface::releaseSavePointSQL()
rollbackSavePointSQL( string $name )
Get the SQL for rollingback a save point.
$name
Cake\Database\DriverInterface::rollbackSavePointSQL()
rollbackTransaction( )
Rollbacks a transaction.
Cake\Database\DriverInterface::rollbackTransaction()
savePointSQL( string $name )
Get the SQL for creating a save point.
$name
Cake\Database\DriverInterface::savePointSQL()
schema( )
Returns the schema name that's being used.
Cake\Database\DriverInterface::schema()
schemaDialect( )
Get the schema dialect.
Cake\Database\Schema\BaseSchema
Cake\Database\DriverInterface::schemaDialect()
schemaValue( mixed $value )
Escapes values for use in schema definitions.
$value
Cake\Database\DriverInterface::schemaValue()
setConnection( PDO $connection )
Set the internal PDO connection instance.
$connection
Cake\Database\DriverInterface::setConnection()
supportsQuoting( )
Checks if the driver supports quoting, as PDO_ODBC does not support it.
Cake\Database\DriverInterface::supportsQuoting()
supportsSavePoints( )
Returns whether this driver supports save points for nested transactions.
Cake\Database\DriverInterface::supportsSavePoints()
_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
_insertQueryTranslator( Cake\Database\Query $query )
Modifies the original insert query to append a "RETURNING *" epilogue so that the latest insert id can be retrieved
$query
_transformDistinct( Cake\Database\Query $query )
Distinct clause needs no transformation
$query
_transformFunctionExpression( Cake\Database\Expression\FunctionExpression $expression )
Receives a FunctionExpression and changes it so that it conforms to this SQL dialect.
$expression
The function expression to convert to postgres SQL.
disableForeignKeySQL( )
enableForeignKeySQL( )
schemaDialect( )
Get the schema dialect.
Used by Cake\Database\Schema package to reflect schema and generate schema.
protected array
Base configuration settings for Postgres driver
[ 'persistent' => true, 'host' => 'localhost', 'username' => 'root', 'password' => '', 'database' => 'cake', 'schema' => 'public', 'port' => 5432, 'encoding' => 'utf8', 'timezone' => null, 'flags' => [], 'init' => [], ]
© 2005–2018 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.Postgres.html