Spec-Zone.ru › CakePHP 3.1

Класс Driver

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

Непосредственные известные подклассы

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

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

__constructsource public

__construct( array $config [] )

Конструктор

Параметры

массив $config необязательный []
Настройка драйвера.

Исключения

InvalidArgumentException
InvalidArgumentException

__debugInfosource public

__debugInfo( )

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

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

array
массив

__destructsource public

__destruct( )

Деструктор

autoQuotingsource public

autoQuoting( boolean $enable null )

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

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

Параметры

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

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

boolean
bool

beginTransactionsource abstract public

beginTransaction( )

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

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

boolean
true при успехе, false в противном случае

commitTransactionsource abstract public

commitTransaction( )

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

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

boolean
true при успехе, false в противном случае

compileQuerysource public

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

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

Параметры

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

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

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

connectsource abstract public

connect( )

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

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

boolean
true при успехе

connectionsource abstract public

connection( null|PDO $connection null )

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

Параметры

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

disableForeignKeySQLsource abstract public

disableForeignKeySQL( )

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

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

string
строка

disconnectsource abstract public

disconnect( )

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

enableForeignKeySQLsource abstract public

enableForeignKeySQL( )

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

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

string
строка

enabledsource abstract public

enabled( )

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

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

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

isConnectedsource public

isConnected( )

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

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

boolean
bool

lastInsertIdsource public

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

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

Параметры

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

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

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

newCompilersource public

newCompiler( )

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

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

Cake\Database\QueryCompiler
\Cake\Database\QueryCompiler

preparesource abstract public

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

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

Параметры

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

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

Cake\Database\StatementInterface
\Cake\Database\StatementInterface

queryTranslatorsource abstract public

queryTranslator( string $type )

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

Параметры

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

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

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

quotesource abstract public

quote( mixed $value , string $type )

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

Параметры

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

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

string
строка
END_OF_DOCUMENT_MARKER

quoteIdentifiersource абстрактный public

quoteIdentifier( string $identifier )

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

Параметры

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

Возвращает

string
строка

releaseSavePointSQLsource абстрактный public

releaseSavePointSQL( string $name )

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

Параметры

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

Возвращает

string
строка

rollbackSavePointSQLsource абстрактный public

rollbackSavePointSQL( string $name )

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

Параметры

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

Возвращает

string
строка

rollbackTransactionsource абстрактный public

rollbackTransaction( )

Откат транзакции

Возвращает

boolean
true при успехе, false в противном случае

savePointSQLsource абстрактный public

savePointSQL( string $name )

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

Параметры

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

Возвращает

string
строка

schemaDialectsource абстрактный public

schemaDialect( )

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

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

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

Возвращает

Cake\Database\Schema\BaseSchema
\Cake\Database\Schema\BaseSchema

schemaValuesource public

schemaValue( mixed $value )

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

Параметры

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

Возвращает

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

supportsDynamicConstraintssource абстрактный public

supportsDynamicConstraints( )

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

Возвращает

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

supportsQuotingsource public

supportsQuoting( )

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

Возвращает

boolean
bool

supportsSavePointssource public

supportsSavePoints( )

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

Возвращает

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

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

$_autoQuotingsource

protected boolean

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

false

$_baseConfigsource

protected массив

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

[]

$_configsource

protected массив

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

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Database.Driver.html

Spec-Zone.ru

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