Класс Driver

Представляет драйвер базы данных, содержащий все особенности движка базы данных, включая его диалект SQL.

Абстрактный
Пространство имён: Cake\Database

Константы

int|null

MAX_ALIAS_LENGTH
```
null
```
int[]

RETRY_ERROR_CODES
```
[]
```

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

$_autoQuoting protected

bool

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

array

Базовая конфигурация, которая объединяется с конфигурацией, предоставленной пользователем.
$_config protected

array

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

PDO

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

string|null

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

int

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

bool|null

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

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

__construct() public

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

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

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

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

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

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

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

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

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

Возвращает SQL для отключения внешних ключей.
disconnect() public

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

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

Возвращает SQL для включения внешних ключей.
enabled() abstract public

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

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

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

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

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

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

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

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

Создает новую TableSchema.
prepare() public

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

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

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

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

Возвращает SQL для выхода из состояния сохранения.
rollbackSavePointSQL() public

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

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

Возвращает SQL для создания состояния сохранения.
schema() public

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

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

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

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

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

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

Проверяет, поддерживает ли драйвер добавление кавычек, так как PDO_ODBC их не поддерживает.
supportsSavePoints() public

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

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

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

__construct() public

__construct(array $config = [])

Конструктор

Параметры

array $config необязательный: Настройка драйвера.

Исключения

InvalidArgumentException

__debugInfo() public

__debugInfo(): array

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

Возвращает

array

__destruct() public

__destruct()

Деструктор

_connect() protected

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

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

Параметры

string $dsn: Указатель на источник данных (PDO-DSN).
array $config: Настройки для создания соединения.

Возвращает

bool

beginTransaction() public

beginTransaction(): bool

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

Возвращает

bool

commitTransaction() public

commitTransaction(): bool

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

Возвращает

bool

compileQuery() public

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

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

Параметры

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

Возвращает

array

connect() abstract public

connect(): bool

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

Возвращает

bool

disableAutoQuoting() public

disableAutoQuoting(): $this

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

Возвращает

$this

disableForeignKeySQL() public

disableForeignKeySQL(): string

Возвращает SQL для отключения внешних ключей.

Возвращает

string

disconnect() public

disconnect(): void

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

Возвращает

void

enableAutoQuoting() public

enableAutoQuoting(bool $enable = true): $this

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

Параметры

bool $enable необязательный

Возвращает

$this

enableForeignKeySQL() public

enableForeignKeySQL(): string

Возвращает SQL для включения внешних ключей.

Возвращает

string

enabled() abstract public

enabled(): bool

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

Возвращает

bool

getConnectRetries() public

getConnectRetries(): int

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

Возвращает

int

getConnection() public

getConnection(): PDO

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

Возвращает

PDO

getMaxAliasLength() public

getMaxAliasLength(): int|null

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

Возвращает

int|null

isAutoQuotingEnabled() public

isAutoQuotingEnabled(): bool

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

Возвращает

bool

isConnected() public

isConnected(): bool

Проверяет, установлено ли соединение.

Возвращает

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

Создаёт новую схему таблицы.

Параметры

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() abstract public

queryTranslator(string $type): Closure

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

Параметры

string $type

Возвращает

Closure

quote() public

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

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

Параметры

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

Возвращает

string

quoteIdentifier() abstract 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() abstract 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

supportsQuoting() public

supportsQuoting(): bool

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

Возвращаемое значение

bool

supportsSavePoints() public

supportsSavePoints(): bool

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

Возвращаемое значение

bool

version() public

version(): string

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

Возвращаемое значение

string

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

`$_autoQuoting` protected

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

Тип

bool

`$_baseConfig` protected

Базовая конфигурация, которая объединяется с конфигурацией, предоставленной пользователем.

Тип

array

`$_config` protected

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

Тип

array

`$_connection` protected

Экземпляр PDO.

Тип

PDO

`$_version` protected

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

Тип

string|null

`$connectRetries` protected

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

Тип

int

`$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.html