Класс Driver
Представляет драйвер базы данных, содержащий все особенности движка базы данных, включая его диалект SQL
Непосредственные известные подклассы
Cake\Database\Driver\Mysql, Cake\Database\Driver\Postgres, Cake\Database\Driver\Sqlite, Cake\Database\Driver\SqlserverПодробное описание методов
__constructsource public
__construct( array $config [] )
Конструктор
Параметры
- массив
$configнеобязательный [] - Настройка драйвера.
Исключения
InvalidArgumentExceptionInvalidArgumentException
__debugInfosource public
__debugInfo( )
Возвращает массив, который может быть использован для описания внутреннего состояния этого объекта.
Возвращаемое значение
arrayмассив
autoQuotingsource public
autoQuoting( boolean $enable null )
Возвращает, следует ли этому драйверу автоматически указывать идентификаторы в запросах
Если вызвано с аргументом boolean, он переключает авто-цитирование на переданное значение
Параметры
- boolean
$enableнеобязательный null - включить авто-цитирование
Возвращаемое значение
booleanbool
beginTransactionsource abstract public
beginTransaction( )
Начинает транзакцию
Возвращаемое значение
booleantrue при успехе, false в противном случае
commitTransactionsource abstract public
commitTransaction( )
Подтверждает транзакцию
Возвращаемое значение
booleantrue при успехе, 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( )
Устанавливает соединение с сервером базы данных
Возвращаемое значение
booleantrue при успехе
connectionsource abstract public
connection( null|PDO $connection null )
Возвращает корректный ресурс или объект соединения, используемый внутри. Если передан первый аргумент,
Параметры
- null|PDO
$connectionнеобязательный null - Объект соединения
disableForeignKeySQLsource abstract public
disableForeignKeySQL( )
Получение SQL для отключения внешних ключей
Возвращаемое значение
stringстрока
enableForeignKeySQLsource abstract public
enableForeignKeySQL( )
Получение SQL для включения внешних ключей
Возвращаемое значение
stringстрока
enabledsource abstract public
enabled( )
Возвращает, может ли php использовать этот драйвер для подключения к базе данных
Возвращаемое значение
booleantrue, если этот драйвер можно использовать
isConnectedsource public
isConnected( )
Проверяет, подключен ли драйвер.
Возвращаемое значение
booleanbool
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строка
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( )
Откат транзакции
Возвращает
booleantrue при успехе, 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( )
Возвращает, поддерживает ли драйвер добавление или удаление ограничений для уже созданных таблиц.
Возвращает
booleantrue, если драйвер поддерживает динамические ограничения
supportsQuotingsource public
supportsQuoting( )
Проверка, поддерживает ли драйвер цитирование
Возвращает
booleanbool
supportsSavePointssource public
supportsSavePoints( )
Возвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций
Возвращает
booleantrue, если точки сохранения поддерживаются, false в противном случае
Краткое описание свойств
© 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