Class Mysql

MySQL Driver

Namespace: Cake\Database\Driver

Constants

int|null

MAX_ALIAS_LENGTH ¶
```
256
```
int[]

RETRY_ERROR_CODES ¶
```
[]
```
string

SERVER_TYPE_MARIADB ¶
```
'mariadb'
```
Server type MariaDB
string

SERVER_TYPE_MYSQL ¶
```
'mysql'
```
Server type MySQL

Property Summary

$_autoQuoting protected

bool

Indicates whether or not the driver is doing automatic identifier quoting for all queries
$_baseConfig protected

array

Base configuration settings for MySQL driver
$_config protected

array

Configuration data.
$_connection protected

PDO

Instance of PDO.
$_endQuote protected

string

String used to end a database identifier quoting to make it safe
$_schemaDialect protected

Cake\Database\Schema\MysqlSchemaDialect|null

The schema dialect for this driver
$_startQuote protected

string

String used to start a database identifier quoting to make it safe
$_supportsNativeJson protected

bool|null

Whether or not the server supports native JSON
$_supportsWindowFunctions protected

bool|null

Whether or not the connected server supports window functions.
$_version protected

string|null

The server version
$connectRetries protected

int

The last number of connection retry attempts.
$featuresToVersionMap protected

array

Mapping of feature to db server version for feature availability checks.
$serverType protected

string

Server type.
$supportsCTEs protected

bool|null

Whether or not the server supports common table expressions.

Method Summary

__construct() public

Constructor
__debugInfo() public

Returns an array that can be used to describe the internal state of this object.
__destruct() public

Destructor
_connect() protected

Establishes a connection to the database server
_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.
beginTransaction() public

Starts a transaction.
commitTransaction() public

Commits a transaction.
compileQuery() public

Transforms the passed query to this Driver's dialect and returns an instance of the transformed query and the full compiled SQL string.
connect() public

Establishes a connection to the database server
disableAutoQuoting() public

Disable auto quoting of identifiers in queries.
disableForeignKeySQL() public

Get the SQL for disabling foreign keys.
disconnect() public

Disconnects from database server.
enableAutoQuoting() public

Sets whether or not this driver should automatically quote identifiers in queries.
enableForeignKeySQL() public

Get the SQL for enabling foreign keys.
enabled() public

Returns whether php is able to use this driver for connecting to database
getConnectRetries() public

Returns the number of connection retry attempts made.
getConnection() public

Get the internal PDO connection instance.
getMaxAliasLength() public

Returns the maximum alias length allowed. This can be different than the maximum identifier length for columns.
isAutoQuotingEnabled() public

Returns whether or not this driver should automatically quote identifiers in queries.
isConnected() public

Checks whether or not the driver is connected.
isMariadb() public

Returns true if the connected server is MariaDB.
lastInsertId() public

Returns last id generated for a table or sequence in database.
newCompiler() public

Returns an instance of a QueryCompiler.
newTableSchema() public

Constructs new TableSchema.
prepare() public

Prepares a sql statement to be executed
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.
quote() public

Returns a value in a safe representation to be used in a query string
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
rollbackTransaction() public

Rollbacks a transaction.
savePointSQL() public

Returns a SQL snippet for creating a new transaction savepoint
schema() public

Returns the schema name that's being used.
schemaDialect() public

Get the schema dialect.
schemaValue() public

Escapes values for use in schema definitions.
setConnection() public

Set the internal PDO connection instance.
supportsCTEs() public

Returns true if the server supports common table expressions.
supportsDynamicConstraints() public

Returns whether the driver supports adding or dropping constraints to already created tables.
supportsNativeJson() public

Returns true if the server supports native JSON columns
supportsQuoting() public

Checks if the driver supports quoting, as PDO_ODBC does not support it.
supportsSavePoints() public

Returns whether this driver supports save points for nested transactions.
supportsWindowFunctions() public

Returns true if the connected server supports window functions.
version() public

Returns connected server version.

Method Detail

__construct() ¶ public

__construct(array $config = [])

Constructor

Parameters

array $config optional: The configuration for the driver.

Throws

InvalidArgumentException

__debugInfo() ¶ public

__debugInfo(): array

Returns an array that can be used to describe the internal state of this object.

Returns

array

__destruct() ¶ public

__destruct()

Destructor

_connect() ¶ protected

_connect(string $dsn, array $config): bool

Establishes a connection to the database server

Parameters

string $dsn: A Driver-specific PDO-DSN
array $config: configuration to be used for creating connection

Returns

bool

_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(): string[]

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

beginTransaction() ¶ public

beginTransaction(): bool

Starts a transaction.

Returns

bool

commitTransaction() ¶ public

commitTransaction(): bool

Commits a transaction.

Returns

bool

compileQuery() ¶ public

compileQuery(Cake\Database\Query $query, Cake\Database\ValueBinder $binder): array

Transforms the passed query to this Driver's dialect and returns an instance of the transformed query and the full compiled SQL string.

Parameters

Cake\Database\Query $query
Cake\Database\ValueBinder $binder

Returns

array

connect() ¶ public

connect(): bool

Establishes a connection to the database server

Returns

bool

disableAutoQuoting() ¶ public

disableAutoQuoting(): $this

Disable auto quoting of identifiers in queries.

Returns

$this

disableForeignKeySQL() ¶ public

disableForeignKeySQL(): string

Get the SQL for disabling foreign keys.

Returns

string

disconnect() ¶ public

disconnect(): void

Disconnects from database server.

Returns

void

enableAutoQuoting() ¶ public

enableAutoQuoting(bool $enable = true): $this

Sets whether or not this driver should automatically quote identifiers in queries.

Parameters

bool $enable optional

Returns

$this

enableForeignKeySQL() ¶ public

enableForeignKeySQL(): string

Get the SQL for enabling foreign keys.

Returns

string

enabled() ¶ public

enabled(): bool

Returns whether php is able to use this driver for connecting to database

Returns

bool

getConnectRetries() ¶ public

getConnectRetries(): int

Returns the number of connection retry attempts made.

Returns

int

getConnection() ¶ public

getConnection(): PDO

Get the internal PDO connection instance.

Returns

PDO

getMaxAliasLength() ¶ public

getMaxAliasLength(): int|null

Returns the maximum alias length allowed. This can be different than the maximum identifier length for columns.

Returns

int|null

isAutoQuotingEnabled() ¶ public

isAutoQuotingEnabled(): bool

Returns whether or not this driver should automatically quote identifiers in queries.

Returns

bool

isConnected() ¶ public

isConnected(): bool

Checks whether or not the driver is connected.

Returns

bool

isMariadb() ¶ public

isMariadb(): bool

Returns true if the connected server is MariaDB.

Returns

bool

lastInsertId() ¶ public

lastInsertId(string|null $table = null, string|null $column = null): string|int

Returns last id generated for a table or sequence in database.

Parameters

string|null $table optional
string|null $column optional

Returns

string|int

newCompiler() ¶ public

newCompiler(): Cake\Database\QueryCompiler

Returns an instance of a QueryCompiler.

Returns

Cake\Database\QueryCompiler

newTableSchema() ¶ public

newTableSchema(string $table, array $columns = []): Cake\Database\Schema\TableSchema

Constructs new TableSchema.

Parameters

string $table
array $columns optional

Returns

Cake\Database\Schema\TableSchema

prepare() ¶ public

prepare(stringCake\Database\Query $query): Cake\Database\StatementInterface

Prepares a sql statement to be executed

Parameters

stringCake\Database\Query $query: The query to prepare.

Returns

Cake\Database\StatementInterface

queryTranslator() ¶ public

queryTranslator(string $type): Closure

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

quote() ¶ public

quote(mixed $value, int $type = PDO::PARAM_STR): string

Returns a value in a safe representation to be used in a query string

Parameters

mixed $value
int $type optional

Returns

string

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|int $name): string

Returns a SQL snippet for releasing a previously created save point

Parameters

string|int $name: save point name

Returns

string

rollbackSavePointSQL() ¶ public

rollbackSavePointSQL(string|int $name): string

Returns a SQL snippet for rollbacking a previously created save point

Parameters

string|int $name: save point name

Returns

string

rollbackTransaction() ¶ public

rollbackTransaction(): bool

Rollbacks a transaction.

Returns

bool

savePointSQL() ¶ public

savePointSQL(string|int $name): string

Returns a SQL snippet for creating a new transaction savepoint

Parameters

string|int $name: save point name

Returns

string

schema() ¶ public

schema(): string

Returns the schema name that's being used.

Returns

string

schemaDialect() ¶ public

schemaDialect(): Cake\Database\Schema\SchemaDialect

Get the schema dialect.

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

If all the tables that use this Driver specify their own schemas, then this may return null.

Returns

Cake\Database\Schema\SchemaDialect

schemaValue() ¶ public

schemaValue(mixed $value): string

Escapes values for use in schema definitions.

Parameters

mixed $value

Returns

string

setConnection() ¶ public

setConnection(object $connection): $this

Set the internal PDO connection instance.

Parameters

object $connection: PDO instance.

Returns

$this

supportsCTEs() ¶ public

supportsCTEs(): bool

Returns true if the server supports common table expressions.

Returns

bool

supportsDynamicConstraints() ¶ public

supportsDynamicConstraints(): bool

Returns whether the driver supports adding or dropping constraints to already created tables.

Returns

bool

supportsNativeJson() ¶ public

supportsNativeJson(): bool

Returns true if the server supports native JSON columns

Returns

bool

supportsQuoting() ¶ public

supportsQuoting(): bool

Checks if the driver supports quoting, as PDO_ODBC does not support it.

Returns

bool

supportsSavePoints() ¶ public

supportsSavePoints(): bool

Returns whether this driver supports save points for nested transactions.

Returns

bool

supportsWindowFunctions() ¶ public

supportsWindowFunctions(): bool

Returns true if the connected server supports window functions.

Returns

bool

version() ¶ public

version(): string

Returns connected server version.

Returns

string

Property Detail

`$_autoQuoting` ¶ protected

Indicates whether or not the driver is doing automatic identifier quoting for all queries

Type

bool

`$_baseConfig` ¶ protected

Base configuration settings for MySQL driver

Type

array

`$_config` ¶ protected

Configuration data.

Type

array

`$_connection` ¶ protected

Instance of PDO.

Type

PDO

`$_endQuote` ¶ protected

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

Type

string

`$_schemaDialect` ¶ protected

The schema dialect for this driver

Type

Cake\Database\Schema\MysqlSchemaDialect|null

`$_startQuote` ¶ protected

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

Type

string

`$_supportsNativeJson` ¶ protected

Whether or not the server supports native JSON

Type

bool|null

`$_supportsWindowFunctions` ¶ protected

Whether or not the connected server supports window functions.

Type

bool|null

`$_version` ¶ protected

The server version

Type

string|null

`$connectRetries` ¶ protected

The last number of connection retry attempts.

Type

int

`$featuresToVersionMap` ¶ protected

Mapping of feature to db server version for feature availability checks.

Type

array

`$serverType` ¶ protected

Server type.

If the underlying server is MariaDB, its value will get set to 'mariadb' after version() method is called.

Type

string

`$supportsCTEs` ¶ protected

Whether or not the server supports common table expressions.

Type

bool|null

Namespaces

Class Mysql

Constants

Property Summary

Method Summary

__construct() public

__debugInfo() public

__destruct() public

_connect() protected

_deleteQueryTranslator() protected

_expressionTranslators() protected

_insertQueryTranslator() protected

_removeAliasesFromConditions() protected

_selectQueryTranslator() protected

_transformDistinct() protected

_updateQueryTranslator() protected

beginTransaction() public

commitTransaction() public

compileQuery() public

connect() public

disableAutoQuoting() public

disableForeignKeySQL() public

disconnect() public

enableAutoQuoting() public

enableForeignKeySQL() public

enabled() public

getConnectRetries() public

getConnection() public

getMaxAliasLength() public

isAutoQuotingEnabled() public

isConnected() public

isMariadb() public

lastInsertId() public

newCompiler() public

newTableSchema() public

prepare() public

queryTranslator() public

quote() public

quoteIdentifier() public

releaseSavePointSQL() public

rollbackSavePointSQL() public

rollbackTransaction() public

savePointSQL() public

schema() public

schemaDialect() public

schemaValue() public

setConnection() public

supportsCTEs() public

supportsDynamicConstraints() public

supportsNativeJson() public

supportsQuoting() public

supportsSavePoints() public

supportsWindowFunctions() public

version() public

Method Detail

__construct() ¶ public

Parameters

Throws

__debugInfo() ¶ public

Returns

__destruct() ¶ public

_connect() ¶ protected

Parameters

Returns

_deleteQueryTranslator() ¶ protected

Parameters

Returns

_expressionTranslators() ¶ protected

Returns

_insertQueryTranslator() ¶ protected

Parameters

Returns

_removeAliasesFromConditions() ¶ protected

Parameters

Returns

Throws

_selectQueryTranslator() ¶ protected

Parameters

Returns

_transformDistinct() ¶ protected