Класс Driver
Представляет драйвер базы данных, содержащий все особенности движка базы данных, включая его диалект SQL.
Прямые подклассы
- Cake\Database\Driver\Mysql
- Cake\Database\Driver\Postgres
- Cake\Database\Driver\Sqlite
- Cake\Database\Driver\Sqlserver
Краткое описание свойств
-
$_autoQuotingprotectedbooleanУказывает, выполняет ли драйвер автоматическую обработку кавычек идентификаторов для всех запросов
-
$_baseConfigprotectedarrayБазовая конфигурация, которая объединяется с предоставленными пользователем данными конфигурации.
-
$_configprotectedДанные конфигурации.array
Краткое описание магических свойств
-
$_connectionpublicPDO|null
Краткое описание методов
- __construct() publicКонструктор
- __debugInfo() public
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
- __destruct() publicДеструктор
- autoQuoting() public
Возвращает, следует ли этому драйверу автоматически заключать идентификаторы в кавычки в запросах
- Начало транзакции
- Подтверждение транзакции
- compileQuery() public
Преобразует переданный запрос в диалект этого драйвера и возвращает экземпляр преобразованного запроса и полную скомпилированную строку SQL
- Устанавливает соединение с сервером базы данных
-
Возвращает правильный ресурс или объект соединения, который используется внутри. Если передан первый аргумент,
- Получение SQL для отключения внешних ключей
- Отключение от сервера базы данных
- enableAutoQuoting() public
Устанавливает, следует ли этому драйверу автоматически заключать идентификаторы в кавычки в запросах.
- Получение SQL для включения внешних ключей
- Возвращает, может ли php использовать этот драйвер для подключения к базе данных
- isAutoQuotingEnabled() public
Возвращает, следует ли этому драйверу автоматически заключать идентификаторы в кавычки в запросах
- 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 [] )
Конструктор
Параметры
- массив
$configнеобязательно [] - Конфигурация для драйвера.
Исключения
InvalidArgumentException__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
массивautoQuoting()source public
autoQuoting( boolean|null $enable null )
Возвращает, следует ли этому драйверу автоматически заключать идентификаторы в кавычки в запросах
Если вызвано с булевым аргументом, это переключит настройку автоматического цитирования на переданное значение
Устарело
3.4.0 используйте enableAutoQuoting()/isAutoQuotingEnabled() вместо этого.Параметры
- булево|null
$enableнеобязательно null - Включить или выключить автоматическое цитирование
Возвращает
булевоbeginTransaction()source abstract public
beginTransaction( )
Начинает транзакцию
Возвращает
booleanистина при успехе, ложь в противном случае
commitTransaction()source abstract public
commitTransaction( )
Подтверждает транзакцию
Возвращает
booleanистина при успехе, ложь в противном случае
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истина при успехе
connection()source abstract public
connection( null|PDO $connection null )
Возвращает правильный ресурс или объект подключения, используемый внутри. Если передан первый аргумент,
Параметры
- null|PDO
$connectionнеобязательный null - Объект подключения
Возвращает
PDOdisableForeignKeySQL()source abstract public
disableForeignKeySQL( )
Получить SQL для отключения внешних ключей
Возвращает
stringenableAutoQuoting()source public
enableAutoQuoting( boolean $enable true )
Устанавливает, следует ли этому драйверу автоматически заключать идентификаторы в запросы.
Параметры
- boolean
$enableнеобязательный true - Включить автоматическое заключение
Возвращает
$this
enableForeignKeySQL()source abstract public
enableForeignKeySQL( )
Получить SQL для включения внешних ключей
Возвращает
stringenabled()source abstract public
enabled( )
Возвращает, может ли php использовать этот драйвер для подключения к базе данных
Возвращает
booleanистина, если использование этого драйвера допустимо
isAutoQuotingEnabled()source public
isAutoQuotingEnabled( )
Возвращает, следует ли этому драйверу автоматически заключать идентификаторы в запросы
Возвращает
booleanlastInsertId()source public
lastInsertId( string|null $table null , string|null $column null )
Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных
Параметры
- string|null
$tableнеобязательный null - имя таблицы или последовательности для получения последнего значения вставки
- string|null
$columnнеобязательный 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( )
Откатывает транзакцию
Возвращает
booleanистина при успехе, ложь в противном случае
savePointSQL()source абстрактный public
savePointSQL( string $name )
Получить SQL для создания точки сохранения.
Параметры
- строка
$name - Имя таблицы
Возвращает
строкаschemaDialect()source абстрактный public
schemaDialect( )
Получить диалект схемы.
Используется пакетом Cake\Database\Schema для отражения схемы и генерации схемы.
Если все таблицы, использующие этот драйвер, указывают свои собственные схемы, то это может вернуть null.
Возвращает
Cake\Database\Schema\BaseSchemaschemaValue()source public
schemaValue( mixed $value )
Экранирует значения для использования в определениях схемы.
Параметры
- смешанный
$value - Значение для экранирования.
Возвращает
строкаСтрока для использования в определениях схемы.
supportsDynamicConstraints()source абстрактный public
supportsDynamicConstraints( )
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
Возвращает
булевоtrue, если драйвер поддерживает динамические ограничения
supportsQuoting()source public
supportsQuoting( )
Проверяет, поддерживает ли драйвер цитирование
Возвращает
булевоsupportsSavePoints()source public
supportsSavePoints( )
Возвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций
Возвращает
булевоtrue, если точки сохранения поддерживаются, в противном случае false
Подробное описание свойств
$_autoQuotingsource
protected булево
Указывает, выполняет ли драйвер автоматическое цитирование идентификаторов для всех запросов
false
$_baseConfigsource
protected массив
Базовая конфигурация, которая объединяется с пользовательскими данными конфигурации.
[]
Подробное описание магических свойств
$_connectionsource
public PDO|null
© 2005–2018 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.5/class-Cake.Database.Driver.html