\Cake\DatabaseSqlDialectTrait

Sql dialect trait

Summary

Methods
Properties
Constants
quoteIdentifier()
queryTranslator()
savePointSQL()
releaseSavePointSQL()
rollbackSavePointSQL()
No public properties found
No constants found
_expressionTranslators()
_selectQueryTranslator()
_transformDistinct()
_deleteQueryTranslator()
_updateQueryTranslator()
_removeAliasesFromConditions()
_insertQueryTranslator()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

quoteIdentifier()

quoteIdentifier(string  $identifier) : string

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

queryTranslator()

queryTranslator(string  $type) : callable

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

savePointSQL()

savePointSQL(string  $name) : string

Returns a SQL snippet for creating a new transaction savepoint

Parameters

string $name

save point name

Returns

string

releaseSavePointSQL()

releaseSavePointSQL(string  $name) : string

Returns a SQL snippet for releasing a previously created save point

Parameters

string $name

save point name

Returns

string

rollbackSavePointSQL()

rollbackSavePointSQL(string  $name) : string

Returns a SQL snippet for rollbacking a previously created save point

Parameters

string $name

save point name

Returns

string

_expressionTranslators()

_expressionTranslators() : array

Returns an associative array of methods that will transform Expression objects to conform with the specific SQL dialect. Keys are class names and values a method in this class.

Returns

array

_selectQueryTranslator()

_selectQueryTranslator(\Cake\Database\Query  $query) : \Cake\Database\Query

Apply translation steps to select queries.

Parameters

\Cake\Database\Query $query

The query to translate

Returns

\Cake\Database\Query

The modified query

_transformDistinct()

_transformDistinct(\Cake\Database\Query  $query) : \Cake\Database\Query

Returns the passed query after rewriting the DISTINCT clause, so that drivers that do not support the "ON" part can provide the actual way it should be done

Parameters

\Cake\Database\Query $query

The query to be transformed

Returns

\Cake\Database\Query

_deleteQueryTranslator()

_deleteQueryTranslator(\Cake\Database\Query  $query) : \Cake\Database\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

_updateQueryTranslator()

_updateQueryTranslator(\Cake\Database\Query  $query) : \Cake\Database\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

_removeAliasesFromConditions()

_removeAliasesFromConditions(\Cake\Database\Query  $query) : \Cake\Database\Query

Removes aliases from the `WHERE` clause of a query.

Parameters

\Cake\Database\Query $query

The query to process.

Throws

\RuntimeException

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

Returns

\Cake\Database\Query

The modified query.

_insertQueryTranslator()

_insertQueryTranslator(\Cake\Database\Query  $query) : \Cake\Database\Query

Apply translation steps to insert queries.

Parameters

\Cake\Database\Query $query

The query to translate

Returns

\Cake\Database\Query

The modified query