Класс Driver
Представляет драйвер базы данных, содержащий все особенности движка базы данных, включая его диалект SQL.
Прямые подклассы
- Cake\Database\Driver\Mysql
- Cake\Database\Driver\Postgres
- Cake\Database\Driver\Sqlite
- Cake\Database\Driver\Sqlserver
Краткое описание свойств
-
$_autoQuotingprotectedbooleanУказывает, выполняет ли драйвер автоматическое цитирование идентификаторов для всех запросов.
-
$_baseConfigprotectedarrayБазовая конфигурация, которая сливается с предоставленными пользователем данными конфигурации.
-
$_configprotectedДанные конфигурации.array
Краткое описание методов
- __construct() publicКонструктор
- __debugInfo() public
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
- __destruct() publicДеструктор
- autoQuoting() public
Возвращает, следует ли этому драйверу автоматически цитировать идентификаторы в запросах.
- Начинает транзакцию
- Завершает транзакцию
- compileQuery() public
Преобразует переданный запрос в диалект этого драйвера и возвращает экземпляр преобразованного запроса и полную скомпилированную строку SQL.
- Устанавливает соединение с сервером базы данных
-
Возвращает правильный ресурс или объект подключения, который используется внутри. Если передан первый аргумент,
- Получает SQL для отключения внешних ключей
- Отключается от сервера базы данных
- Получает SQL для включения внешних ключей
- Возвращает, может ли php использовать этот драйвер для подключения к базе данных
- isConnected() publicПроверяет, подключен ли драйвер.
- lastInsertId() publicВозвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных
- newCompiler() publicВозвращает экземпляр QueryCompiler
- Подготавливает sql-запрос для выполнения
-
Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернёт экземпляр объекта Query, который был преобразован для обеспечения соответствия любым особенностям диалекта SQL, используемого в данный момент.
- Возвращает значение в безопасном представлении для использования в строке запроса
-
Цитирует идентификатор базы данных (имя столбца, имя таблицы и т. д.) для безопасного использования в запросах, исключая риск использования зарезервированных слов.
- Получает SQL для высвобождения точки сохранения.
- Получает SQL для отката точки сохранения.
- Откатывает транзакцию
- Получает SQL для создания точки сохранения.
- schema() publicВозвращает имя схемы, используемой в данный момент
- Получает диалект схемы.
- schemaValue() publicИспользует значения для экранирования в определениях схем.
-
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
- supportsQuoting() publicПроверяет, поддерживает ли драйвер цитирование
- supportsSavePoints() publicВозвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций
Подробное описание методов
__construct()source public
__construct( array $config [] )
Конструктор
Параметры
- array
$configнеобязательно [] - Конфигурация драйвера.
Исключения
InvalidArgumentException__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
arrayautoQuoting()source public
autoQuoting( boolean|null $enable null )
Возвращает, следует ли этому драйверу автоматически цитировать идентификаторы в запросах
Если вызвана с булевым аргументом, она переключит настройку автоматического цитирования на переданное значение
Параметры
- boolean|null
$enableнеобязательно null - включить или отключить автоматическое цитирование
Возвращает
booleanbeginTransaction()source abstract public
beginTransaction( )
Начинает транзакцию
Возвращает
booleantrue при успехе, false в противном случае
commitTransaction()source abstract public
commitTransaction( )
Завершает транзакцию
Возвращает
booleantrue при успехе, 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( )
Устанавливает соединение с сервером базы данных
Возвращаемое значение
booleantrue при успехе
connection()source abstract public
connection( null|PDO $connection null )
Возвращает правильный ресурс или объект соединения, используемый внутри. Если передан первый аргумент,
Параметры
- null|PDO
$connectionoptional null - Объект соединения
disableForeignKeySQL()source abstract public
disableForeignKeySQL( )
Возвращает SQL для отключения внешних ключей
Возвращаемое значение
stringenableForeignKeySQL()source abstract public
enableForeignKeySQL( )
Возвращает SQL для включения внешних ключей
Возвращаемое значение
stringenabled()source abstract public
enabled( )
Возвращает, может ли php использовать этот драйвер для подключения к базе данных
Возвращаемое значение
booleantrue, если этот драйвер допустимо использовать
isConnected()source public
isConnected( )
Проверяет, подключен ли драйвер.
Возвращаемое значение
booleanlastInsertId()source public
lastInsertId( string|null $table null , string|null $column null )
Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных
Параметры
- string|null
$tableoptional null - Имя таблицы или последовательности для получения последнего значения вставки
- string|null
$columnoptional null - Имя столбца, представляющего первичный ключ
Возвращаемое значение
string|integernewCompiler()source public
newCompiler( )
Возвращает экземпляр QueryCompiler
Возвращаемое значение
Cake\Database\QueryCompilerprepare()source abstract public
prepare( string|Cake\Database\Query $query )
Подготавливает оператор SQL для выполнения
Параметры
- string|
Cake\Database\Query$query - Запрос, который нужно преобразовать в оператор.
Возвращаемое значение
Cake\Database\StatementInterfacequeryTranslator()source abstract public
queryTranslator( string $type )
Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернёт экземпляр объекта Query, который был преобразован для соответствия особенностям используемого диалекта SQL.
Параметры
- string
$type тип запроса, который требуется преобразовать (select, insert, update, delete)
Возвращаемое значение
callablequote()source abstract public
quote( mixed $value , string $type )
Возвращает значение в безопасном представлении для использования в строке запроса
Параметры
- mixed
$value - Значение для кавычек.
- string
$type - Тип, используемый для определения вида кавычек
Возвращаемое значение
stringquoteIdentifier()source abstract public
quoteIdentifier( string $identifier )
Приводит идентификатор базы данных (имя столбца, имя таблицы и т. д.) к безопасной форме для использования в запросах, чтобы избежать использования зарезервированных слов
Параметры
- string
$identifier - Выражение идентификатора для кавычек.
Возвращаемое значение
stringreleaseSavePointSQL()source abstract public
releaseSavePointSQL( string $name )
Возвращает SQL для освобождения точки сохранения.
Параметры
- string
$name - Имя таблицы
Возвращаемое значение
stringrollbackSavePointSQL()source abstract public
rollbackSavePointSQL( string $name )
Возвращает SQL для отката точки сохранения.
Параметры
- string
$name - Имя таблицы
Возвращаемое значение
stringrollbackTransaction()source abstract public
rollbackTransaction( )
Откатывает транзакцию
Возвращаемое значение
booleantrue при успехе, false в противном случае
savePointSQL()source abstract public
savePointSQL( string $name )
Возвращает SQL для создания точки сохранения.
Параметры
- string
$name - Имя таблицы
Возвращаемое значение
stringschema()source public
schema( )
Возвращает имя схемы, которое используется
Возвращаемое значение
stringschemaDialect()source abstract public
schemaDialect( )
Возвращает диалект схемы.
Используется пакетом Cake\Database\Schema для отражения схемы и генерации схемы.
Если все таблицы, использующие этот драйвер, указывают свои собственные схемы, то это может вернуть null.
Возвращаемое значение
Cake\Database\Schema\BaseSchemaschemaValue()source public
schemaValue( mixed $value )
Экранирует значения для использования в определениях схем.
Параметры
- mixed
$value - Значение для экранирования.
Возвращаемое значение
stringСтрока для использования в определениях схем.
supportsDynamicConstraints()source abstract public
supportsDynamicConstraints( )
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
Возвращает
booleantrue, если драйвер поддерживает динамические ограничения
supportsQuoting()source public
supportsQuoting( )
Проверяет, поддерживает ли драйвер цитирование.
Возвращает
booleansupportsSavePoints()source public
supportsSavePoints( )
Возвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций
Возвращает
booleantrue, если точки сохранения поддерживаются, в противном случае false
Подробное описание свойств
$_autoQuotingsource
protected boolean
Указывает, выполняет ли драйвер автоматическое цитирование идентификаторов для всех запросов.
false
$_baseConfigsource
protected array
Базовая конфигурация, которая объединяется с предоставленными пользователем данными конфигурации.
[]
© 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.3/class-Cake.Database.Driver.html