Spec-Zone.ru › CakePHP 3.7

Интерфейс DriverInterface

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

Прямые реализаторы

  • Cake\Database\Driver

Непрямые реализаторы

  • Cake\Database\Driver\Mysql
  • Cake\Database\Driver\Postgres
  • Cake\Database\Driver\Sqlite
  • Cake\Database\Driver\Sqlserver
Пространство имён: Cake\Database
Расположение: Database/DriverInterface.php

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

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

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

  • connect() public
    Устанавливает соединение с сервером базы данных.
  • disableForeignKeySQL() public
    Возвращает SQL-запрос для отключения внешних ключей.
  • disconnect() public
    Отключается от сервера базы данных.
  • enableAutoQuoting() public

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

  • enableForeignKeySQL() public
    Возвращает SQL-запрос для включения внешних ключей.
  • enabled() public
    Возвращает, может ли php использовать этот драйвер для подключения к базе данных.
  • getConnection() public
    Возвращает правильный ресурс или объект соединения, используемый внутри.
  • isAutoQuotingEnabled() public

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

  • isConnected() public
    Проверяет, подключен ли драйвер.
  • lastInsertId() public
    Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных.
  • newCompiler() public
    Возвращает экземпляр QueryCompiler.
  • 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
    Возвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций.

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

beginTransaction()source public

beginTransaction( )

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

Возвращает

boolean
Истина при успехе, ложь в противном случае.

commitTransaction()source public

commitTransaction( )

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

Возвращает

boolean
Истина при успехе, ложь в противном случае.

compileQuery()source public

compileQuery( Cake\Database\Query $query , Cake\Database\ValueBinder $generator )

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

Параметры

Cake\Database\Query $query
Запрос для компиляции.
Cake\Database\ValueBinder $generator
Используемый связующий объект значений.

Возвращает

array

содержащий 2 записи. Первый элемент — преобразованный запрос, второй — скомпилированная строка SQL.


connect()source public

connect( )

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

Возвращает

boolean
Истина при успехе, ложь при ошибке.

disableForeignKeySQL()source public

disableForeignKeySQL( )

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

Возвращает

string

disconnect()source public

disconnect( )

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

enableAutoQuoting()source public

enableAutoQuoting( boolean $enable = true )

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

Параметры

boolean $enable optional true
Включить автоматическое заключение в кавычки

Возвращает


$this

enableForeignKeySQL()source public

enableForeignKeySQL( )

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

Возвращает

string

enabled()source public

enabled( )

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

Возвращает

boolean
Истина, если данный драйвер можно использовать.
END_OF_DOCUMENT_MARKER

getConnection()source public

getConnection( )

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

Возвращает

object
Внутренний объект подключения.

isAutoQuotingEnabled()source public

isAutoQuotingEnabled( )

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

Возвращает

boolean

isConnected()source public

isConnected( )

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

Возвращает

boolean

lastInsertId()source public

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

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

Параметры

string|null $table необязательно null
Имя таблицы или последовательности, чтобы получить последнее значение вставки.
string|null $column необязательно null
Имя столбца, представляющего первичный ключ.

Возвращает

string|integer

newCompiler()source public

newCompiler( )

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

Возвращает

Cake\Database\QueryCompiler

prepare()source public

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

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

Параметры

string|Cake\Database\Query $query
Запрос, который нужно преобразовать в подготовленный запрос.

Возвращает

Cake\Database\StatementInterface

queryTranslator()source public

queryTranslator( string $type )

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

Параметры

string $type

Тип запроса, который необходимо преобразовать (select, insert, update, delete).

Возвращает

callable

quote()source public

quote( mixed $value , string $type )

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

Параметры

mixed $value
Значение для заключания в кавычки.
string $type
Тип, используемый для определения типа заключания в кавычки.

Возвращает

string

quoteIdentifier()source public

quoteIdentifier( string $identifier )

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

Параметры

string $identifier
Выражение идентификатора для заключания в кавычки.

Возвращает

string

releaseSavePointSQL()source public

releaseSavePointSQL( string $name )

Получает SQL для освобождения точки сохранения.

Параметры

string $name
Имя таблицы.

Возвращает

string

rollbackSavePointSQL()source public

rollbackSavePointSQL( string $name )

Получает SQL для отката точки сохранения.

Параметры

string $name
Имя таблицы.

Возвращает

string

rollbackTransaction()source public

rollbackTransaction( )

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

Возвращает

boolean
True при успехе, иначе false.

savePointSQL()source public

savePointSQL( string $name )

Получает SQL для создания точки сохранения.

Параметры

string $name
Имя таблицы.

Возвращает

string

schema()source public

schema( )

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

Возвращает

string

schemaDialect()source public

schemaDialect( )

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

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

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

Возвращает

Cake\Database\Schema\BaseSchema

schemaValue()source public

schemaValue( mixed $value )

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

Параметры

mixed $value
Значение для экранирования.

Возвращает

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

setConnection()source public

setConnection( object $connection )

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

Параметры

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

Возвращает


$this

supportsDynamicConstraints()source public

supportsDynamicConstraints( )

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

Возвращает

boolean
true, если драйвер поддерживает динамические ограничения.

supportsQuoting()source public

supportsQuoting( )

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

Возвращает

boolean

supportsSavePoints()source public

supportsSavePoints( )

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

Возвращает

boolean
True, если точки сохранения поддерживаются, иначе false.

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

Spec-Zone.ru

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