W3cubDocs

/CakePHP 3.4

Trait SqlDialectTrait

Sql dialect trait

Method Summary

  • Apply translation steps to delete queries.
  • 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.

  • Apply translation steps to insert queries.
  • Removes aliases from the WHERE clause of a query.
  • Apply translation steps to select queries.
  • 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

  • Apply translation steps to update queries.
  • 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.

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

  • Returns a SQL snippet for releasing a previously created save point
  • Returns a SQL snippet for rollbacking a previously created save point
  • Returns a SQL snippet for creating a new transaction savepoint

Method Detail

_deleteQueryTranslator()source 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()source 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

array

_insertQueryTranslator()source 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()source 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()source 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()source 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()source 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()source 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

quoteIdentifier()source 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()source public

releaseSavePointSQL( string $name )

Returns a SQL snippet for releasing a previously created save point

Parameters

string $name
save point name

Returns

string

rollbackSavePointSQL()source public

rollbackSavePointSQL( string $name )

Returns a SQL snippet for rollbacking a previously created save point

Parameters

string $name
save point name

Returns

string

savePointSQL()source public

savePointSQL( string $name )

Returns a SQL snippet for creating a new transaction savepoint

Parameters

string $name
save point name

Returns

string

© 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.SqlDialectTrait.html