Интерфейс DriverInterface

Интерфейс для драйвера базы данных.

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

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

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 @method

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

Возвращает корректный ресурс или объект подключения, используемый внутри.
getMaxAliasLength() public @method

Возвращает максимальную длину псевдонима.
isAutoQuotingEnabled() public

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

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

Возвращает последний сгенерированный id для таблицы или последовательности в базе данных.
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

Устанавливает внутренний объект подключения.
supportsDynamicConstraints() public

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

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

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

END_OF_DOCUMENT_MARKER

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

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

connect(): bool

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

Возвращает

bool

Исключения

Cake\Database\Exception\MissingConnectionException
Если подключение к базе данных не удалось установить.

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

enabled(): bool

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

Возвращает

bool

getConnectRetries() public @method

getConnectRetries(): int

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

Возвращает

int

getConnection() public

getConnection(): object

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

Возвращает

object

getMaxAliasLength() public @method

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

Создаёт новую 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): string

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

Параметры

mixed $value: Значение для приведения к кавычкам.
int $type: Должно быть одним из констант \PDO::PARAM_*

Возвращает

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

Установить внутренний объект подключения.

Параметры

object $connection: Экземпляр подключения.

Возвращает

$this

supportsDynamicConstraints() public

supportsDynamicConstraints(): bool

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

Возвращает

bool

supportsQuoting() public

supportsQuoting(): bool

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

Возвращает

bool

supportsSavePoints() public

supportsSavePoints(): bool

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

Возвращает

bool

© 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/interface-Cake.Database.DriverInterface.html