Класс Driver
Представляет драйвер базы данных, содержащий все особенности движка базы данных, включая его диалект SQL.
- Cake\Database\Driver реализует Cake\Database\DriverInterface
Прямые подклассы
- Cake\Database\Driver\Mysql
- Cake\Database\Driver\Postgres
- Cake\Database\Driver\Sqlite
- Cake\Database\Driver\Sqlserver
Резюме свойств
-
$_autoQuotingprotectedbooleanУказывает, выполняет ли драйвер автоматическое приведение идентификаторов в кавычки для всех запросов
-
$_baseConfigprotectedarrayБазовая конфигурация, которая объединяется с предоставленными пользователем данными конфигурации.
-
$_configprotectedДанные конфигурации.array -
$_connectionprotectedЭкземпляр PDO.PDO|null
Резюме методов
- __construct() publicКонструктор
- __debugInfo() public
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
- __destruct() publicДеструктор
- _connect() protectedУстанавливает соединение с сервером базы данных
-
Возвращает, следует ли этому драйверу автоматически приводить идентификаторы в кавычки в запросах
- beginTransaction() publicНачинает транзакцию.
- commitTransaction() publicПодтверждает транзакцию.
- compileQuery() public
Преобразует переданный запрос в диалект этого драйвера и возвращает экземпляр преобразованного запроса и полную скомпилированную строку SQL.
- Устанавливает соединение с сервером базы данных.
-
Возвращает правильный ресурс или объект соединения, который используется внутри. Если передан первый аргумент, он установит внутренний объект соединения или результат в переданное значение.
- Получить SQL для отключения внешних ключей.
- disconnect() publicОтключается от сервера базы данных.
- enableAutoQuoting() public
Устанавливает, следует ли этому драйверу автоматически приводить идентификаторы в кавычки в запросах.
- Получить SQL для включения внешних ключей.
- Возвращает, может ли php использовать этот драйвер для подключения к базе данных.
- getConnection() publicПолучить внутренний экземпляр соединения PDO.
- isAutoQuotingEnabled() public
Возвращает, следует ли этому драйверу автоматически приводить идентификаторы в кавычки в запросах.
- isConnected() publicПроверяет, подключен ли драйвер.
- lastInsertId() publicВозвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных.
- newCompiler() publicВозвращает экземпляр QueryCompiler.
- prepare() publicПодготавливает sql-запрос для выполнения.
-
Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернёт экземпляр объекта Query, который был преобразован для учёта особенностей используемого диалекта SQL.
- quote() publicВозвращает значение в безопасной форме для использования в строке запроса
-
Приводит в кавычки идентификатор базы данных (имя столбца, имя таблицы и т. д.) для безопасного использования в запросах без риска использования зарезервированных слов.
- Получить SQL для освобождения точки сохранения.
- Получить SQL для отката точки сохранения.
- rollbackTransaction() publicОткатывает транзакцию.
- Получить SQL для создания точки сохранения.
- schema() publicВозвращает имя схемы, которое используется.
- Получить диалект схемы.
- schemaValue() publicВыполняет экранирование значений для использования в определениях схемы.
- setConnection() publicУстанавливает внутренний экземпляр соединения PDO.
-
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
- supportsQuoting() publicПроверяет, поддерживает ли драйвер приведение в кавычки, так как PDO_ODBC не поддерживает это.
- supportsSavePoints() publicВозвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций.
Подробное описание метода
__construct()source public
__construct( array $config = [] )
Конструктор
Параметры
- массив
$configoptional [] - Конфигурация для драйвера.
Исключения
InvalidArgumentException__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
массив_connect()source protected
_connect( string $dsn , array $config )
Устанавливает соединение с сервером базы данных
Параметры
- string
$dsn - Специфичный для драйвера PDO-DSN
- array
$config - конфигурация, используемая для создания соединения
Возвращает
booleantrue при успехе
autoQuoting()source public deprecated
autoQuoting( boolean|null $enable = null )
Возвращает, должен ли этот драйвер автоматически заключать идентификаторы в запросах
Если вызвана с аргументом boolean, она переключит настройку автоматического заключения в указанное значение
Устарело
3.4.0 используйте enableAutoQuoting()/isAutoQuotingEnabled() вместо этого.Параметры
- boolean|null
$enableнеобязательно null - Включить ли автоматическое заключение
Возвращает
booleanbeginTransaction()source public
beginTransaction( )
Начинает транзакцию.
Возвращает
booleanИстина при успехе, ложь в противном случае.
Реализация
Cake\Database\DriverInterface::beginTransaction() commitTransaction()source public
commitTransaction( )
Подтверждает транзакцию.
Возвращает
booleanИстина при успехе, ложь в противном случае.
Реализация
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 - Используемый связующий объект значений.
Возвращает
arrayсодержащий 2 записи. Первый элемент — преобразованный запрос, второй — скомпилированная SQL.
Реализация
Cake\Database\DriverInterface::compileQuery() connect()source abstract public
connect( )
Устанавливает соединение с сервером базы данных.
Возвращает
booleanИстина при успехе, ложь при ошибке.
Реализация
Cake\Database\DriverInterface::connect() connection()source public deprecated
connection( mixed $connection = null )
Возвращает правильный ресурс или объект соединения, используемый внутри. Если первый аргумент передан, он установит внутренний объект соединения или результат в переданное значение.
Устарело
3.6.0 Используйте getConnection()/setConnection() вместо этого.Параметры
- mixed
$connectionнеобязательно null - экземпляр соединения PDO.
Возвращает
mixedВнутренний объект соединения.
disableForeignKeySQL()source abstract public
disableForeignKeySQL( )
Получает SQL для отключения внешних ключей.
Возвращает
stringРеализация
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 для включения внешних ключей.
Возвращает
stringРеализация
Cake\Database\DriverInterface::enableForeignKeySQL() enabled()source abstract public
enabled( )
Возвращает, может ли php использовать этот драйвер для подключения к базе данных.
Возвращает
booleanИстина, если этот драйвер можно использовать.
Реализация
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 )
Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных.
Параметры
- string|null
$tableнеобязательно null - Имя таблицы или последовательности, чтобы получить последнее вставленное значение.
- string|null
$columnнеобязательно null - Имя столбца, представляющего первичный ключ.
Возвращает
string|integerРеализация
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-запрос для выполнения.
Параметры
- string|
Cake\Database\Query$query - Запрос, который должен быть преобразован в подготовленный запрос.
Возвращает
Cake\Database\StatementInterfaceРеализация
Cake\Database\DriverInterface::prepare() queryTranslator()source abstract public
queryTranslator( string $type )
Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернет экземпляр объекта Query, который был преобразован для соответствия специфике диалекта SQL, используемого в настоящий момент.
Параметры
- string
$type Тип запроса, подлежащего преобразованию (select, insert, update, delete).
Возвращает
callableРеализация
Cake\Database\DriverInterface::queryTranslator() 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( )
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
Возвращаемое значение
booleantrue, если драйвер поддерживает динамические ограничения.
Реализация
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
Базовая конфигурация, которая объединяется с предоставленной пользователем конфигурацией.
[]
© 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.6/class-Cake.Database.Driver.html