CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.3 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.3
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Console
    • Controller
    • Core
    • Database
      • Dialect
      • Driver
      • Exception
      • Expression
      • Log
      • Schema
      • Statement
      • Type
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Trait MysqlDialectTrait

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

Namespace: Cake\Database\Dialect

Property Summary

  • $_endQuote protected
    string

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

  • $_schemaDialect protected
    Cake\Database\Schema\MysqlSchema

    The schema dialect class for this driver

  • $_startQuote protected
    string

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

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.

  • disableForeignKeySQL() public

    {@inheritDoc}

  • enableForeignKeySQL() public

    {@inheritDoc}

  • queryTranslator() public

    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.

  • 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

  • schemaDialect() public

    Get the schema dialect.

Method Detail

_deleteQueryTranslator() ¶ protected

_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

_expressionTranslators() ¶ protected

_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

_insertQueryTranslator() ¶ protected

_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

_removeAliasesFromConditions() ¶ protected

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

Returns
Cake\Database\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): Cake\Database\Query

Apply translation steps to select queries.

Parameters
Cake\Database\Query $query

The query to translate

Returns
Cake\Database\Query

_transformDistinct() ¶ protected

_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

_updateQueryTranslator() ¶ protected

_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

disableForeignKeySQL() ¶ public

disableForeignKeySQL()

{@inheritDoc}

enableForeignKeySQL() ¶ public

enableForeignKeySQL()

{@inheritDoc}

queryTranslator() ¶ public

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

quoteIdentifier() ¶ public

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

releaseSavePointSQL() ¶ public

releaseSavePointSQL(string $name): string

Returns a SQL snippet for releasing a previously created save point

Parameters
string $name

save point name

Returns
string

rollbackSavePointSQL() ¶ public

rollbackSavePointSQL(string $name): string

Returns a SQL snippet for rollbacking a previously created save point

Parameters
string $name

save point name

Returns
string

savePointSQL() ¶ public

savePointSQL(string $name): string

Returns a SQL snippet for creating a new transaction savepoint

Parameters
string $name

save point name

Returns
string

schemaDialect() ¶ public

schemaDialect(): Cake\Database\Schema\MysqlSchema

Get the schema dialect.

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

Returns
Cake\Database\Schema\MysqlSchema

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

$_startQuote ¶ protected

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

Type
string
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs