Spec-Zone.ru › CakePHP 3.4

Класс Driver

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

Прямые подклассы

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

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

  • $_autoQuoting protected
    boolean

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

  • $_baseConfig protected
    array

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

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

Краткое описание магических свойств

  • $_connection public
    Cake\Datasource\ConnectionInterface

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

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

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

  • __destruct() public
    Деструктор
  • autoQuoting() public

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

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

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

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

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

  • disableForeignKeySQL() abstract public
    Получить SQL для отключения внешних ключей
  • disconnect() abstract public
    Отключается от сервера базы данных
  • enableAutoQuoting() public

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

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

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

  • isConnected() public
    Проверяет, подключен ли драйвер.
  • lastInsertId() public
    Возвращает последний сгенерированный ID для таблицы или последовательности в базе данных
  • newCompiler() public
    Возвращает экземпляр QueryCompiler
  • prepare() abstract public
    Подготавливает оператор SQL для выполнения
  • queryTranslator() abstract public

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

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

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

  • releaseSavePointSQL() abstract public
    Получить SQL для выпуска контрольной точки
  • rollbackSavePointSQL() abstract public
    Получить SQL для отката контрольной точки
  • rollbackTransaction() abstract public
    Отменяет транзакцию
  • savePointSQL() abstract public
    Получить SQL для создания контрольной точки
  • schema() public
    Возвращает имя схемы, которое используется
  • schemaDialect() abstract public
    Получить диалект схемы
  • schemaValue() public
    Выводит значения для использования в определениях схем.
  • supportsDynamicConstraints() abstract public

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

  • supportsQuoting() public
    Проверяет, поддерживает ли драйвер цитирование
  • supportsSavePoints() public
    Возвращает, поддерживает ли этот драйвер контрольные точки для вложенных транзакций

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

__construct()source public

__construct( array $config [] )

Конструктор

Параметры

массив $config необязательный []
Конфигурация для драйвера.

Исключения

InvalidArgumentException

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__destruct()source public

__destruct( )

Деструктор

autoQuoting()source public

autoQuoting( boolean|null $enable null )

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

Если вызвано с булевым аргументом, оно переключит настройку автоматического цитирования на переданное значение

Устарело

3.4.0 использовать enableAutoQuoting()/isAutoQuotingEnabled() вместо этого.

Параметры

boolean|null $enable необязательный null
Включить ли автоматическое цитирование

Возвращает

boolean
END_OF_DOCUMENT_MARKER

beginTransaction()source abstract public

beginTransaction( )

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

Возвращает

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

commitTransaction()source abstract public

commitTransaction( )

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

Возвращает

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

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

connect( )

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

Возвращает

boolean
true при успехе

connection()source abstract public

connection( null|PDO $connection null )

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

Параметры

null|PDO $connection необязательный null
Объект подключения

Возвращает

PDO

disableForeignKeySQL()source abstract public

disableForeignKeySQL( )

Получает SQL для отключения внешних ключей

Возвращает

string

disconnect()source abstract public

disconnect( )

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

enableAutoQuoting()source public

enableAutoQuoting( boolean $enable true )

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

Параметры

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

Возвращает


$this

enableForeignKeySQL()source abstract public

enableForeignKeySQL( )

Получает SQL для включения внешних ключей

Возвращает

string

enabled()source abstract public

enabled( )

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

Возвращает

boolean
true, если этот драйвер можно использовать

isAutoQuotingEnabled()source public

isAutoQuotingEnabled( )

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

Возвращает

boolean

isConnected()source public

isConnected( )

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

Возвращает

boolean

lastInsertId()source public

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

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

Параметры

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

Возвращает

string|integer

newCompiler()source public

newCompiler( )

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

Возвращает

Cake\Database\QueryCompiler

prepare()source abstract public

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

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

Параметры

string|Cake\Database\Query $query
Запрос для преобразования в оператор.

Возвращает

Cake\Database\StatementInterface

queryTranslator()source abstract public

queryTranslator( string $type )

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

Параметры

string $type

тип запроса, который будет преобразован (select, insert, update, delete)

Возвращает

callable

quote()source abstract public

quote( mixed $value , string $type )

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

Параметры

mixed $value
Значение для заключения в кавычки.
string $type
Тип для определения вида заключения в кавычки

Возвращает

string

quoteIdentifier()source abstract public

quoteIdentifier( string $identifier )

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

Параметры

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

Возвращает

string

releaseSavePointSQL()source abstract public

releaseSavePointSQL( string $name )

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

Параметры

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

Возвращает

string

rollbackSavePointSQL()source abstract public

rollbackSavePointSQL( string $name )

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

Параметры

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

Возвращает

string

rollbackTransaction()source abstract public

rollbackTransaction( )

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

Возвращает

boolean
true при успехе, иначе false
END_OF_DOCUMENT_MARKER

savePointSQL()source abstract public

savePointSQL( string $name )

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

Параметры

строка $name
Имя таблицы

Возвращает

строка

schema()source public

schema( )

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

Возвращает

строка

schemaDialect()source abstract public

schemaDialect( )

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

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

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

Возвращает

Cake\Database\Schema\BaseSchema

schemaValue()source public

schemaValue( mixed $value )

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

Параметры

смешанный $value
Значение для экранирования.

Возвращает

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

supportsDynamicConstraints()source abstract public

supportsDynamicConstraints( )

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

Возвращает

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

supportsQuoting()source public

supportsQuoting( )

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

Возвращает

boolean

supportsSavePoints()source public

supportsSavePoints( )

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

Возвращает

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

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

$_autoQuotingsource

protected boolean

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

false

$_baseConfigsource

protected массив

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

[]

$_configsource

protected массив

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

Подробное описание магических свойств

$_connectionsource

public Cake\Datasource\ConnectionInterface

© 2005–2017 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.4/class-Cake.Database.Driver.html

Spec-Zone.ru

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