Класс Mysql

Драйвер MySQL

Пространство имён: Cake\Database\Driver

Константы

int|null

MAX_ALIAS_LENGTH
```
256
```
int[]

RETRY_ERROR_CODES
```
[]
```
string

SERVER_TYPE_MARIADB
```
'mariadb'
```
Тип сервера MariaDB
string

SERVER_TYPE_MYSQL
```
'mysql'
```
Тип сервера MySQL

Краткое описание свойств

$_autoQuoting protected

bool

Указывает, производит ли драйвер автоматическое цитирование идентификаторов для всех запросов
$_baseConfig protected

array

Основные параметры конфигурации для драйвера MySQL
$_config protected

array

Данные конфигурации.
$_connection protected

PDO

Экземпляр PDO.
$_endQuote protected

string

Строка, используемая для завершения цитирования идентификатора базы данных для обеспечения безопасности
$_schemaDialect protected

Cake\Database\Schema\MysqlSchemaDialect|null

Диалект схемы для данного драйвера
$_startQuote protected

string

Строка, используемая для начала цитирования идентификатора базы данных для обеспечения безопасности
$_supportsNativeJson protected

bool|null

Поддерживает ли сервер native JSON
$_supportsWindowFunctions protected

bool|null

Поддерживает ли подключённый сервер функции окна.
$_version protected

string|null

Версия сервера
$connectRetries protected

int

Количество последних попыток повторного подключения.
$featuresToVersionMap protected

array

Сопоставление функций с версией сервера БД для проверки доступности функций.
$serverType protected

string

Тип сервера.
$supportsCTEs protected

bool|null

Поддерживает ли сервер выражения общих таблиц.

Краткое описание методов

__construct() public

Конструктор
__debugInfo() public

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
__destruct() public

Деструктор
_connect() protected

Устанавливает соединение с сервером базы данных
_deleteQueryTranslator() protected

Применение шагов трансляции к запросам удаления.
_expressionTranslators() protected

Возвращает ассоциативный массив методов, которые преобразуют объекты Expression для соответствия конкретному диалекту SQL. Ключи — имена классов, значения — метод в этом классе.
_insertQueryTranslator() protected

Применение шагов трансляции к запросам вставки.
_removeAliasesFromConditions() protected

Удаляет алиасы из части WHERE запроса.
_selectQueryTranslator() protected

Применение шагов трансляции к запросам выбора.
_transformDistinct() protected

Возвращает переданный запрос после переписывания предложения DISTINCT, так что драйверы, не поддерживающие часть «ON», могут предоставить фактический способ сделать это.
_updateQueryTranslator() protected

Применение шагов трансляции к запросам обновления.
beginTransaction() public

Начинает транзакцию.
commitTransaction() public

Подтверждает транзакцию.
compileQuery() public

Преобразует переданный запрос в диалект этого драйвера и возвращает экземпляр преобразованного запроса и полную скомпилированную строку SQL.
connect() public

Устанавливает соединение с сервером базы данных
disableAutoQuoting() public

Отключает автоматическое цитирование идентификаторов в запросах.
disableForeignKeySQL() public

Получает SQL-код для отключения внешних ключей.
disconnect() public

Отключается от сервера базы данных.
enableAutoQuoting() public

Устанавливает, должен ли этот драйвер автоматически цитировать идентификаторы в запросах.
enableForeignKeySQL() public

Получает SQL-код для включения внешних ключей.
enabled() public

Возвращает, может ли php использовать этот драйвер для подключения к базе данных
getConnectRetries() public

Возвращает количество попыток повторного подключения.
getConnection() public

Получить внутренний экземпляр соединения PDO.
getMaxAliasLength() public

Возвращает максимальную длину алиаса. Она может отличаться от максимальной длины идентификатора столбцов.
isAutoQuotingEnabled() public

Возвращает, должен ли этот драйвер автоматически цитировать идентификаторы в запросах.
isConnected() public

Проверяет, подключен ли драйвер.
isMariadb() public

Возвращает true, если подключенный сервер — MariaDB.
lastInsertId() public

Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных.
newCompiler() public

Возвращает экземпляр QueryCompiler.
newTableSchema() public

Создаёт новый TableSchema.
prepare() public

Подготавливает SQL-запрос для выполнения.
queryTranslator() public

Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернёт экземпляр объекта Query, преобразованного для учёта особенностей используемого диалекта SQL.
quote() public

Возвращает значение в безопасном представлении для использования в строке запроса.
quoteIdentifier() public

Цитирует идентификатор базы данных (имя столбца, имя таблицы и т. д.) для безопасного использования в запросах без риска использования зарезервированных слов.
releaseSavePointSQL() public

Возвращает фрагмент SQL для освобождения ранее созданной точки сохранения.
rollbackSavePointSQL() public

Возвращает фрагмент SQL для отката ранее созданной точки сохранения.
rollbackTransaction() public

Откатывает транзакцию.
savePointSQL() public

Возвращает фрагмент SQL для создания новой точки сохранения транзакции.
schema() public

Возвращает имя схемы, которое используется.
schemaDialect() public

Получить диалект схемы.
schemaValue() public

Экранирует значения для использования в определениях схемы.
setConnection() public

Устанавливает внутренний экземпляр соединения PDO.
supportsCTEs() public

Возвращает true, если сервер поддерживает общие табличные выражения.
supportsDynamicConstraints() public

Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
supportsNativeJson() public

Возвращает true, если сервер поддерживает столбцы native JSON.
supportsQuoting() public

Проверяет, поддерживает ли драйвер цитирование, так как PDO_ODBC его не поддерживает.

supportsSavePoints() public

Возвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций.
supportsWindowFunctions() public

Возвращает true, если подключенный сервер поддерживает оконные функции.
version() public

Возвращает версию подключенного сервера.

Метод Detail

__construct() public

__construct(array $config = [])

Конструктор

Parameters

array $config optional: Конфигурация для драйвера.

Throws

InvalidArgumentException

__debugInfo() public

__debugInfo(): array

Возвращает массив, который может быть использован для описания внутреннего состояния этого объекта.

Returns

array

__destruct() public

__destruct()

Деструктор

_connect() protected

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

Устанавливает соединение с сервером базы данных

Parameters

string $dsn: Специфичный для драйвера PDO-DSN
array $config: конфигурация, которая будет использоваться для создания соединения

Returns

bool

_deleteQueryTranslator() protected

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

Применяет шаги перевода к запросам удаления.

Удаляет псевдонимы в условиях запроса на удаление, так как большинство диалектов баз данных не поддерживают псевдонимы в запросах на удаление. Это также удаляет псевдонимы в именах таблиц, так как они часто тоже не работают.

Мы намеренно не поддерживаем удаления с соединениями, так как они имеют еще более слабую поддержку.

Parameters

Cake\Database\Query $query: Запрос для перевода

Returns

Cake\Database\Query

_expressionTranslators() protected

_expressionTranslators(): string[]

Возвращает ассоциативный массив методов, которые будут преобразовывать объекты Expression в соответствии с конкретным диалектом SQL. Ключи - это имена классов, а значения - метод в этом классе.

Returns

string[]

_insertQueryTranslator() protected

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

Применяет шаги перевода к запросам вставки.

Parameters

Cake\Database\Query $query: Запрос для перевода

Returns

Cake\Database\Query

_removeAliasesFromConditions() protected

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

Удаляет псевдонимы из WHERE -клаузулы запроса.

Parameters

Cake\Database\Query $query: Запрос для обработки.

Returns

Cake\Database\Query

Throws

RuntimeException
В случае, если обработанный запрос содержит какие-либо соединения, поскольку удаление псевдонимов из условий может нарушить ссылки на объединенные таблицы.

_selectQueryTranslator() protected

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

Применяет шаги перевода к запросам выбора.

Parameters

Cake\Database\Query $query: Запрос для перевода

Returns

Cake\Database\Query

_transformDistinct() protected

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

Возвращает переданный запрос после переписывания DISTINCT-клаузулы, так чтобы драйверы, которые не поддерживают часть "ON", могли обеспечить фактический способ его выполнения

Parameters

Cake\Database\Query $query: Запрос для преобразования

Returns

Cake\Database\Query

_updateQueryTranslator() protected

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

Применяет шаги перевода к запросам обновления.

Удаляет псевдонимы в условиях запроса обновления, так как не все диалекты баз данных поддерживают псевдонимы в запросах обновления.

Как и для запросов удаления, соединения в настоящее время не поддерживаются для запросов обновления.

Parameters

Cake\Database\Query $query: Запрос для перевода

Returns

Cake\Database\Query

beginTransaction() public

beginTransaction(): bool

Начинает транзакцию.

Returns

bool

commitTransaction() public

commitTransaction(): bool

Завершает транзакцию.

Returns

bool

compileQuery() public

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

Преобразует переданный запрос в диалект этого драйвера и возвращает экземпляр преобразованного запроса и полную скомпилированную строку SQL.

Parameters

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

Returns

array

connect() public

connect(): bool

Устанавливает соединение с сервером базы данных

Returns

bool

disableAutoQuoting() public

disableAutoQuoting(): $this

Отключить автоматическое кавычирование идентификаторов в запросах.

Returns

$this

disableForeignKeySQL() public

disableForeignKeySQL(): string

Получить SQL для отключения внешних ключей.

Returns

string

disconnect() public

disconnect(): void

Отключается от сервера базы данных.

Returns

void

enableAutoQuoting() public

enableAutoQuoting(bool $enable = true): $this

Устанавливает, должен ли этот драйвер автоматически заключать идентификаторы в кавычки в запросах.

Parameters

bool $enable optional

Returns

$this

enableForeignKeySQL() public

enableForeignKeySQL(): string

Получить SQL для включения внешних ключей.

Returns

string

enabled() public

enabled(): bool

Возвращает, может ли php использовать этот драйвер для подключения к базе данных

Returns

bool

getConnectRetries() public

getConnectRetries(): int

Возвращает количество попыток повторного подключения.

Returns

int

getConnection() public

getConnection(): PDO

Получить внутренний экземпляр соединения PDO.

Returns

PDO

getMaxAliasLength() public

getMaxAliasLength(): int|null

Возвращает максимально допустимую длину псевдонима. Это может отличаться от максимальной длины идентификатора для столбцов.

Returns

int|null

isAutoQuotingEnabled() public

isAutoQuotingEnabled(): bool

Возвращает, должен ли этот драйвер автоматически заключать идентификаторы в кавычки в запросах.

Returns

bool

isConnected() public

isConnected(): bool

Проверяет, подключен ли драйвер.

Returns

bool

isMariadb() public

isMariadb(): bool

Возвращает true, если подключенный сервер — MariaDB.

Возвращает

bool

lastInsertId() public

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

Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных.

Параметры

string|null $table необязательно
string|null $column необязательно

Возвращает

string|int

newCompiler() public

newCompiler(): Cake\Database\QueryCompiler

Возвращает экземпляр QueryCompiler.

Возвращает

Cake\Database\QueryCompiler

newTableSchema() public

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

Создает новую TableSchema.

Параметры

string $table
array $columns необязательно

Возвращает

Cake\Database\Schema\TableSchema

prepare() public

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

Подготавливает SQL-запрос к выполнению

Параметры

stringCake\Database\Query $query: Запрос для подготовки.

Возвращает

Cake\Database\StatementInterface

queryTranslator() public

queryTranslator(string $type): Closure

Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернёт экземпляр объекта Query, преобразованного для соответствия специфике используемого диалекта SQL.

Параметры

string $type: тип запроса для преобразования (select, insert, update, delete)

Возвращает

Closure

quote() public

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

Возвращает значение в безопасном представлении для использования в строке запроса

Параметры

mixed $value
int $type необязательно

Возвращает

string

quoteIdentifier() public

quoteIdentifier(string $identifier): string

Приводит имя базы данных (имя столбца, имя таблицы и т. д.) к безопасной форме для использования в запросах, избегая использования зарезервированных слов.

Параметры

string $identifier: Имя для обработки.

Возвращает

string

releaseSavePointSQL() public

releaseSavePointSQL(string|int $name): string

Возвращает фрагмент SQL для освобождения ранее созданной точки сохранения.

Параметры

string|int $name: Имя точки сохранения.

Возвращает

string

rollbackSavePointSQL() public

rollbackSavePointSQL(string|int $name): string

Возвращает фрагмент SQL для отката ранее созданной точки сохранения.

Параметры

string|int $name: Имя точки сохранения.

Возвращает

string

rollbackTransaction() public

rollbackTransaction(): bool

Откатывает транзакцию.

Возвращает

bool

savePointSQL() public

savePointSQL(string|int $name): string

Возвращает фрагмент SQL для создания новой точки сохранения транзакции.

Параметры

string|int $name: Имя точки сохранения.

Возвращает

string

schema() public

schema(): string

Возвращает имя схемы, используемой в данный момент.

Возвращает

string

schemaDialect() public

schemaDialect(): Cake\Database\Schema\SchemaDialect

Получает диалект схемы.

Используется пакетом Cake\Database\Schema для отражения схемы и генерации схемы.

Если все таблицы, использующие этот драйвер, указывают свои схемы, то это может вернуть null.

Возвращает

Cake\Database\Schema\SchemaDialect

schemaValue() public

schemaValue(mixed $value): string

Экранирует значения для использования в определениях схемы.

Параметры

mixed $value

Возвращает

string

setConnection() public

setConnection(object $connection): $this

Устанавливает внутренний экземпляр подключения PDO.

Параметры

object $connection: Экземпляр PDO.

Возвращает

$this

supportsCTEs() public

supportsCTEs(): bool

Возвращает true, если сервер поддерживает выражения с общими таблицами.

Возвращает

bool

supportsDynamicConstraints() public

supportsDynamicConstraints(): bool

Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.

Возвращает

bool

supportsNativeJson() public

supportsNativeJson(): bool

Возвращает true, если сервер поддерживает столбцы с JSON.

Возвращает

bool

supportsQuoting() public

supportsQuoting(): bool

Проверяет, поддерживает ли драйвер цитирование, так как PDO_ODBC его не поддерживает.

Возвращает

bool

supportsSavePoints() public

supportsSavePoints(): bool

Возвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций.

Возвращает

bool

supportsWindowFunctions() public

supportsWindowFunctions(): bool

Возвращает true, если подключенный сервер поддерживает оконные функции.

Возвращает

bool

version() public

version(): string

Возвращает версию подключенного сервера.

Возвращает

string

Подробное описание свойства

`$_autoQuoting` protected

Указывает, выполняет ли драйвер автоматическое цитирование идентификаторов для всех запросов

Тип

bool

`$_baseConfig` protected

Основные параметры конфигурации для драйвера MySQL

Тип

array

`$_config` protected

Данные конфигурации.

Тип

array

`$_connection` protected

Экземпляр PDO.

Тип

PDO

`$_endQuote` protected

Строка, используемая для завершения цитирования идентификатора базы данных для обеспечения безопасности

Тип

string

`$_schemaDialect` protected

Диалект схемы для этого драйвера

Тип

Cake\Database\Schema\MysqlSchemaDialect|null

`$_startQuote` protected

Строка, используемая для начала цитирования идентификатора базы данных для обеспечения безопасности

Тип

string

`$_supportsNativeJson` protected

Поддерживает ли сервер родной JSON

Тип

bool|null

`$_supportsWindowFunctions` protected

Поддерживает ли подключённый сервер функции окон.

Тип

bool|null

`$_version` protected

Версия сервера

Тип

string|null

`$connectRetries` protected

Последнее количество попыток повторного подключения.

Тип

int

`$featuresToVersionMap` protected

Сопоставление функции с версией сервера БД для проверки доступности функции.

Тип

array

`$serverType` protected

Тип сервера.

Если базовый сервер MariaDB, его значение будет установлено в 'mariadb' после вызова метода version().

Тип

string

`$supportsCTEs` protected

Поддерживает ли сервер выражения с общими таблицами.

Тип

bool|null

© 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.2/class-Cake.Database.Driver.Mysql.html