Класс Driver

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

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

Константы

string

FEATURE_CTE
```
'cte'
```
Поддержка выражений с общим табличным представлением (с клаузой).
string

FEATURE_DISABLE_CONSTRAINT_WITHOUT_TRANSACTION
```
'disable-constraint-without-transaction'
```
Поддержка отключения ограничений без транзакции.
string

FEATURE_JSON
```
'json'
```
Поддержка собственного типа данных JSON.
string

FEATURE_QUOTE
```
'quote'
```
Поддержка PDO::quote().
string

FEATURE_SAVEPOINT
```
'savepoint'
```
Поддержка сохранения точки транзакции.
string

FEATURE_TRUNCATE_WITH_CONSTRAINTS
```
'truncate-with-constraints'
```
Поддержка усечения с присоединёнными внешними ключами.
string

FEATURE_WINDOW
```
'window'
```
Поддержка оконных функций (все или частичные клаузы).
int|null

MAX_ALIAS_LENGTH
```
null
```
array<int>

RETRY_ERROR_CODES
```
[]
```

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

$_autoQuoting protected

bool

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

array<string, mixed>

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

array<string, mixed>

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

PDO

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

string|null

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

int

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

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

__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

Возвращает максимальную длину псевдонима. Она может отличаться от максимальной длины идентификатора столбцов.
inTransaction() 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.
supports() public

Возвращает, поддерживает ли драйвер функцию.
supportsCTEs() public deprecated

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

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

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

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

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

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

__construct() public

__construct(array<string, mixed> $config = [])

Конструктор

Параметры

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

Исключения

InvalidArgumentException

__debugInfo() public

__debugInfo(): array<string, mixed>

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

Возвращает

array<string, mixed>

__destruct() public

__destruct()

Деструктор

_connect() protected

_connect(string $dsn, array<string, mixed> $config): bool

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

Параметры

string $dsn: Специфичный для драйвера PDO-DSN
array<string, mixed> $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 optional

Возвращает

$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

inTransaction() public

inTransaction(): bool

Возвращает, активна ли транзакция для соединения.

Возвращает

bool

isAutoQuotingEnabled() public

isAutoQuotingEnabled(): bool

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

Возвращает

bool

isConnected() public

isConnected(): bool

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

Возвращает

bool

lastInsertId() public

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

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

Параметры

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

Возвращает

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 optional

Возвращает

Cake\Database\Schema\TableSchema

prepare() public

prepare(Cake\Database\Query|string $query): Cake\Database\StatementInterface

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

Параметры

Cake\Database\Query|string $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 optional

Возвращает

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

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

Используется пакетом {@link \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

supports() public

supports(string $feature): bool

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

По умолчанию возвращает true для FEATURE_QUOTE и FEATURE_SAVEPOINT.

Параметры

string $feature: Имя функции драйвера

Возвращает

bool

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<string, mixed>

`$_config` protected

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

Тип

array<string, mixed>

`$_connection` protected

Экземпляр PDO.

Тип

PDO

`$_version` protected

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

Тип

string|null

`$connectRetries` protected

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

Тип

int

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

Класс Driver

Константы

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

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

__construct() public

__debugInfo() public

__destruct() public

_connect() protected

beginTransaction() public

commitTransaction() public

compileQuery() public

connect() abstract public

disableAutoQuoting() public

disableForeignKeySQL() public

disconnect() public

enableAutoQuoting() public

enableForeignKeySQL() public

enabled() abstract public

getConnectRetries() public

getConnection() public

getMaxAliasLength() public

inTransaction() public

isAutoQuotingEnabled() public

isConnected() public

lastInsertId() public

newCompiler() public

newTableSchema() public

prepare() public

queryTranslator() abstract public

quote() public

quoteIdentifier() abstract public

releaseSavePointSQL() public

rollbackSavePointSQL() public

rollbackTransaction() public

savePointSQL() public

schema() public

schemaDialect() abstract public

schemaValue() public

setConnection() public

supports() public

supportsCTEs() public deprecated

supportsDynamicConstraints() public deprecated

supportsQuoting() public deprecated

supportsSavePoints() public

version() public

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

__construct() public

Параметры

Исключения

__debugInfo() public

Возвращает

__destruct() public

_connect() protected

Параметры

Возвращает

beginTransaction() public

Возвращает

commitTransaction() public

Возвращает

compileQuery() public

Параметры

Возвращает

connect() abstract public

Возвращает

disableAutoQuoting() public

Возвращает

disableForeignKeySQL() public

Возвращает

disconnect() public

Возвращает

enableAutoQuoting() public

Параметры

Возвращает

enableForeignKeySQL() public

Возвращает

enabled() abstract public

Возвращает

getConnectRetries() public

Возвращает

getConnection() public

`$_autoQuoting` protected

`$_baseConfig` protected

`$_config` protected