Trait SqlDialectTrait

Sql dialect trait

Namespace: Cake\Database\Driver

Method Summary

  • _deleteQueryTranslator() protected

    Apply translation steps to delete queries.

  • _expressionTranslators() protected

    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.

  • _insertQueryTranslator() protected

    Apply translation steps to insert queries.

  • _removeAliasesFromConditions() protected

    Removes aliases from the WHERE clause of a query.

  • _selectQueryTranslator() protected

    Apply translation steps to select queries.

  • _transformDistinct() protected

    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

  • _updateQueryTranslator() protected

    Apply translation steps to update queries.

  • queryTranslator() public

    Returns a callable function that will be used to transform a passed Query object.

  • quoteIdentifier() public

    Quotes a database identifier (a column name, table name, etc..) to be used safely in queries without the risk of using reserved words

  • releaseSavePointSQL() public

    Returns a SQL snippet for releasing a previously created save point

  • rollbackSavePointSQL() public

    Returns a SQL snippet for rollbacking a previously created save point

  • savePointSQL() public

    Returns a SQL snippet for creating a new transaction savepoint

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

string[]

_insertQueryTranslator() protected 

_insertQueryTranslator(\Cake\Database\Query $query)

Apply translation steps to insert queries.

Parameters

\Cake\Database\Query $query

The query to translate

Returns

\Cake\Database\Query

The modified 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)

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

_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

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

© 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.1/trait-Cake.Database.Driver.SqlDialectTrait.html