Spec-Zone.ru › CakePHP 3.8

Класс Driver

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

Cake\Database\Driver реализует Cake\Database\DriverInterface

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

  • 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 protected
    PDO|null
    Экземпляр PDO.

Резюме методов

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

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

  • __destruct() public
    Деструктор
  • _connect() protected
    Устанавливает подключение к серверу базы данных
  • autoQuoting() public deprecated

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

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

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

  • connect() abstract public
    Устанавливает подключение к серверу базы данных.
  • connection() public deprecated

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

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

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

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

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

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

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

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

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

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

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

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

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

__construct()source public

__construct( array $config = [] )

Конструктор

Параметры

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

Исключение

InvalidArgumentException

__debugInfo()source public

__debugInfo( )

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

Возвращаемое значение

array

__destruct()source public

__destruct( )

Деструктор

END_OF_DOCUMENT_MARKER

_connect()source protected

_connect( string $dsn , array $config )

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

Параметры

строка $dsn
Указатель PDO-DSN, специфичный для драйвера
массив $config
Настройка, используемая для создания соединения

Возвращает

boolean
true при успехе

autoQuoting()source public deprecated

autoQuoting( boolean|null $enable = null )

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

Если вызов с аргументом boolean, то переключает авто-указание на переданное значение

Устарело

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

Параметры

boolean|null $enable необязательно null
Включить авто-указание

Возвращает

boolean

beginTransaction()source public

beginTransaction( )

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

Возвращает

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

Реализация

Cake\Database\DriverInterface::beginTransaction()

commitTransaction()source public

commitTransaction( )

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

Возвращает

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

Реализация

Cake\Database\DriverInterface::commitTransaction()

compileQuery()source public

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

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

Параметры

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

Возвращает

массив

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


Реализация

Cake\Database\DriverInterface::compileQuery()

connect()source abstract public

connect( )

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

Возвращает

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

Реализация

Cake\Database\DriverInterface::connect()

connection()source public deprecated

connection( mixed $connection = null )

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

Устарело

3.6.0 Используйте getConnection()/setConnection() вместо этого.

Параметры

смешанный $connection необязательно null
Экземпляр соединения PDO.

Возвращает

смешанный
Внутренний объект соединения.

disableAutoQuoting()source public

disableAutoQuoting( )

Отключает автоматическое указание идентификаторов в запросах.

Возвращает


$this

disableForeignKeySQL()source abstract public

disableForeignKeySQL( )

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

Возвращает

строка

Реализация

Cake\Database\DriverInterface::disableForeignKeySQL()

disconnect()source public

disconnect( )

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

Реализация

Cake\Database\DriverInterface::disconnect()

enableAutoQuoting()source public

enableAutoQuoting( boolean $enable = true )

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

Параметры

boolean $enable необязательно true
Включить авто-указание

Возвращает


$this

Реализация

Cake\Database\DriverInterface::enableAutoQuoting()

enableForeignKeySQL()source abstract public

enableForeignKeySQL( )

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

Возвращает

строка

Реализация

Cake\Database\DriverInterface::enableForeignKeySQL()

enabled()source abstract public

enabled( )

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

Возвращает

boolean
True, если этот драйвер допустимо использовать.

Реализация

Cake\Database\DriverInterface::enabled()

getConnection()source public

getConnection( )

Получить внутренний экземпляр PDO-соединения.

Возвращает

PDO

Реализация

Cake\Database\DriverInterface::getConnection()

isAutoQuotingEnabled()source public

isAutoQuotingEnabled( )

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

Возвращает

boolean

Реализация

Cake\Database\DriverInterface::isAutoQuotingEnabled()

isConnected()source public

isConnected( )

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

Возвращает

boolean

Реализация

Cake\Database\DriverInterface::isConnected()

lastInsertId()source public

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

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

Параметры

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

Возвращает

строка|целое число

Реализация

Cake\Database\DriverInterface::lastInsertId()

newCompiler()source public

newCompiler( )

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

Возвращает

Cake\Database\QueryCompiler

Реализация

Cake\Database\DriverInterface::newCompiler()

prepare()source public

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

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

Параметры

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

Возвращает

Cake\Database\StatementInterface

Реализация

Cake\Database\DriverInterface::prepare()

queryTranslator()source abstract public

queryTranslator( string $type )

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

Параметры

строка $type

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

Возвращает

вызываемая функция

Реализация

Cake\Database\DriverInterface::queryTranslator()
END_OF_DOCUMENT_MARKER

quote()source public

quote( mixed $value , string $type )

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

Параметры

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

Возвращает

string

Реализация

Cake\Database\DriverInterface::quote()

quoteIdentifier()source abstract public

quoteIdentifier( string $identifier )

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

Параметры

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

Возвращает

string

Реализация

Cake\Database\DriverInterface::quoteIdentifier()

releaseSavePointSQL()source abstract public

releaseSavePointSQL( string $name )

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

Параметры

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

Возвращает

string

Реализация

Cake\Database\DriverInterface::releaseSavePointSQL()

rollbackSavePointSQL()source abstract public

rollbackSavePointSQL( string $name )

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

Параметры

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

Возвращает

string

Реализация

Cake\Database\DriverInterface::rollbackSavePointSQL()

rollbackTransaction()source public

rollbackTransaction( )

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

Возвращает

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

Реализация

Cake\Database\DriverInterface::rollbackTransaction()

savePointSQL()source abstract public

savePointSQL( string $name )

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

Параметры

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

Возвращает

string

Реализация

Cake\Database\DriverInterface::savePointSQL()

schema()source public

schema( )

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

Возвращает

string

Реализация

Cake\Database\DriverInterface::schema()

schemaDialect()source abstract public

schemaDialect( )

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

Возвращает

Cake\Database\Schema\BaseSchema

Реализация

Cake\Database\DriverInterface::schemaDialect()

schemaValue()source public

schemaValue( mixed $value )

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

Параметры

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

Возвращает

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

Реализация

Cake\Database\DriverInterface::schemaValue()

setConnection()source public

setConnection( PDO $connection )

Устанавливает внутренний экземпляр подключения PDO.

Параметры

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

Возвращает


$this

Реализация

Cake\Database\DriverInterface::setConnection()

supportsDynamicConstraints()source abstract public

supportsDynamicConstraints( )

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

Возвращает

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

Реализация

Cake\Database\DriverInterface::supportsDynamicConstraints()

supportsQuoting()source public

supportsQuoting( )

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

Возвращает

boolean

Реализация

Cake\Database\DriverInterface::supportsQuoting()

supportsSavePoints()source public

supportsSavePoints( )

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

Возвращает

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

Реализация

Cake\Database\DriverInterface::supportsSavePoints()

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

$_autoQuotingsource

protected boolean

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

false

$_baseConfigsource

protected array

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

[]

$_configsource

protected array

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

$_connectionsource

protected PDO|null

Экземпляр PDO.

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

Spec-Zone.ru

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