Trait PostgresDialectTrait

Contains functions that encapsulates the SQL dialect used by Postgres, including query translators and schema introspection.

Namespace: Cake\Database\Dialect

Properties summary

  • $_endQuote protected
    string

    String used to end a database identifier quoting to make it safe

  • $_schemaDialect protected
    \Cake\Database\Schema\PostgresSchema

    The schema dialect class for this driver

  • $_startQuote protected
    string

    String used to start a database identifier quoting to make it safe

Method Summary

Method Detail

_deleteQueryTranslator() protected 

_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.

Parameters

\Cake\Database\Query $query

The query to translate

Returns

\Cake\Database\Query

The modified query

_expressionTranslators() 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() 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

_removeAliasesFromConditions() protected 

_removeAliasesFromConditions(\Cake\Database\Query $query)

Removes aliases from the WHERE clause of a query.

Parameters

\Cake\Database\Query $query

The query to process.

Returns

\Cake\Database\Query

The modified query.

Throws

RuntimeException
In case the processed query contains any joins, as removing aliases from the conditions can break references to the joined tables.

_selectQueryTranslator() protected 

_selectQueryTranslator(\Cake\Database\Query $query)

Apply translation steps to select queries.

Parameters

\Cake\Database\Query $query

The query to translate

Returns

\Cake\Database\Query

The modified query

_transformDistinct() 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() 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.

_updateQueryTranslator() protected 

_updateQueryTranslator(\Cake\Database\Query $query)

Apply translation steps to update queries.

Chops out aliases on update query conditions as not all database dialects do support aliases in update queries.

Just like for delete queries, joins are currently not supported for update queries.

Parameters

\Cake\Database\Query $query

The query to translate

Returns

\Cake\Database\Query

The modified query

disableForeignKeySQL() public 

disableForeignKeySQL()

enableForeignKeySQL() public 

enableForeignKeySQL()

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

\Closure

quoteIdentifier() 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 to quote.

Returns

string

releaseSavePointSQL() public 

releaseSavePointSQL(mixed $name)

Returns a SQL snippet for releasing a previously created save point

Parameters

string|int $name

save point name

Returns

string

rollbackSavePointSQL() public 

rollbackSavePointSQL(mixed $name)

Returns a SQL snippet for rollbacking a previously created save point

Parameters

string|int $name

save point name

Returns

string

savePointSQL() public 

savePointSQL(mixed $name)

Returns a SQL snippet for creating a new transaction savepoint

Parameters

string|int $name

save point name

Returns

string

schemaDialect() public 

schemaDialect()

Get the schema dialect.

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

Returns

\Cake\Database\Schema\BaseSchema

Property Detail

$_endQuote protected

String used to end a database identifier quoting to make it safe

Type

string

$_schemaDialect protected

The schema dialect class for this driver

Type

\Cake\Database\Schema\PostgresSchema

$_startQuote protected

String used to start a database identifier quoting to make it safe

Type

string

© 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/4.0/trait-Cake.Database.Dialect.PostgresDialectTrait.html