Spec-Zone.ru › CakePHP 4.3

Интерфейс DriverInterface

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

Пространство имён: 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'

    Поддержка оконных функций (все или частичные клаузы).

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

  • 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

    Возвращает максимальную длину псевдонима, разрешённую.

  • inTransaction() 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

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

  • supports() public @method

    Проверяет, поддерживается ли функция драйвером.

  • supportsDynamicConstraints() public deprecated

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

  • supportsQuoting() public deprecated

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

  • supportsSavePoints() public deprecated

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

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

inTransaction() public @method 

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 необязательно

Имя таблицы или последовательности, для получения последнего вставленного значения.

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(Cake\Database\Query|string $query): Cake\Database\StatementInterface

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

Параметры

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

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

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

supports() public @method 

supports(string $feature): bool

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

Параметры

string $feature

Возвращает

bool

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API