W3cubDocs

/CakePHP 3.4

Class Postgres

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

Cake\Database\Driver

Cake\Database\Driver\Postgres uses Cake\Database\Driver\PDODriverTrait , Cake\Database\Dialect\PostgresDialectTrait

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

Properties summary

$_baseConfig protected

array
Base configuration settings for Postgres driver

Inherited Properties

_autoQuoting, _config _connection _endQuote, _schemaDialect, _startQuote

Method Summary

connect() public
Establishes a connection to the database server
enabled() public
Returns whether php is able to use this driver for connecting to database
setEncoding() public
Sets connection encoding
setSchema() public

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
supportsDynamicConstraints() public

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

Method Detail

connect()source public

connect( )

Establishes a connection to the database server

Returns

boolean
true on success

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

setEncoding()source public

setEncoding( string $encoding )

Sets connection encoding

Parameters

string $encoding: The encoding to use.

setSchema()source public

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

Parameters

string $schema: The schema names to set search_path to.

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

Methods inherited from Cake\Database\Driver

__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

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

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.

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

Methods used from Cake\Database\Driver\PDODriverTrait

_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

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

connection()source public

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

Parameters

null|PDO $connection optional null: The PDO connection instance.

Returns

PDO
connection object used internally

disconnect()source public

disconnect( )

Disconnects from database server

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

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

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

rollbackTransaction()source public

rollbackTransaction( )

Rollback a transaction

Returns

boolean
true on success, false otherwise

supportsQuoting()source public

supportsQuoting( )

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

Returns

boolean

Methods used from Cake\Database\Dialect\PostgresDialectTrait

_expressionTranslators()source protected

_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

Returns

array

_insertQueryTranslator()source protected

_insertQueryTranslator( Cake\Database\Query $query )

Modifies the original insert query to append a "RETURNING *" epilogue so that the latest insert id can be retrieved

Parameters

Cake\Database\Query $query: The query to translate.

Returns

Cake\Database\Query

_transformDistinct()source protected

_transformDistinct( Cake\Database\Query $query )

Distinct clause needs no transformation

Parameters

Cake\Database\Query $query: The query to be transformed

Returns

Cake\Database\Query

_transformFunctionExpression()source protected

_transformFunctionExpression( Cake\Database\Expression\FunctionExpression $expression )

Receives a FunctionExpression and changes it so that it conforms to this SQL dialect.

Parameters

Cake\Database\Expression\FunctionExpression $expression: The function expression to convert to postgres SQL.

disableForeignKeySQL()source public

disableForeignKeySQL( )

enableForeignKeySQL()source public

enableForeignKeySQL( )

schemaDialect()source public

schemaDialect( )

Get the schema dialect.

Used by Cake\Database\Schema package to reflect schema and generate schema.

Returns

Cake\Database\Schema\PostgresSchema

Properties detail

$_baseConfigsource

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–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.Postgres.html