Интерфейс DriverInterface
Интерфейс для драйвера базы данных.
Прямые реализаторы
Косвенные реализаторы
- Cake\Database\Driver\Mysql
- Cake\Database\Driver\Postgres
- Cake\Database\Driver\Sqlite
- Cake\Database\Driver\Sqlserver
Краткое описание методов
- beginTransaction() publicИнициализирует транзакцию.
- commitTransaction() publicПодтверждает транзакцию.
- compileQuery() public
Преобразует переданный запрос в диалект этого драйвера и возвращает экземпляр преобразованного запроса и полную скомпилированную строку SQL.
- connect() publicУстанавливает соединение с сервером базы данных.
- disableForeignKeySQL() publicВозвращает SQL для отключения внешних ключей.
- disconnect() publicОтключается от сервера базы данных.
- enableAutoQuoting() public
Устанавливает, следует ли этому драйверу автоматически заключать идентификаторы в запросы.
- enableForeignKeySQL() publicВозвращает SQL для включения внешних ключей.
- enabled() publicВозвращает, может ли php использовать этот драйвер для подключения к базе данных.
- getConnection() publicВозвращает правильный ресурс или объект соединения, используемый внутри.
- isAutoQuotingEnabled() public
Возвращает, следует ли этому драйверу автоматически заключать идентификаторы в запросы.
- isConnected() publicПроверяет, подключён ли драйвер.
- lastInsertId() publicВозвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных.
- newCompiler() publicВозвращает экземпляр QueryCompiler.
- prepare() publicПодготавливает sql-запрос для выполнения.
- queryTranslator() public
Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернёт экземпляр объекта Query, преобразованного для соответствия особенностям используемого диалекта SQL.
- quote() publicВозвращает значение в безопасном представлении для использования в строке запроса
- quoteIdentifier() public
Заключает идентификатор базы данных (имя столбца, имя таблицы и т. д.) в кавычки для безопасного использования в запросах, избегая риска использования зарезервированных слов.
- releaseSavePointSQL() publicВозвращает SQL для освобождения точки сохранения.
- rollbackSavePointSQL() publicВозвращает SQL для отката точки сохранения.
- rollbackTransaction() publicОткатывает транзакцию.
- savePointSQL() publicВозвращает SQL для создания точки сохранения.
- schema() publicВозвращает имя схемы, которое используется.
- schemaDialect() publicВозвращает диалект схемы.
- schemaValue() publicЭкранирует значения для использования в определениях схемы.
- setConnection() publicУстанавливает внутренний объект соединения.
- supportsDynamicConstraints() public
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
- supportsQuoting() publicПроверяет, поддерживает ли драйвер кавычки.
- supportsSavePoints() publicВозвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций.
Подробное описание методов
beginTransaction()source public
beginTransaction( )
Инициализирует транзакцию.
Возвращает
booleanИстина при успехе, ложь в противном случае.
commitTransaction()source 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 public
connect( )
Устанавливает соединение с сервером базы данных.
Возвращает
booleanИстина при успехе, ложь при ошибке.
disableForeignKeySQL()source public
disableForeignKeySQL( )
Возвращает SQL для отключения внешних ключей.
Возвращает
stringenableAutoQuoting()source public
enableAutoQuoting( boolean $enable = true )
Устанавливает, следует ли этому драйверу автоматически заключать идентификаторы в запросы.
Параметры
- boolean
$enableнеобязательно true - Включить автоматическое заключение в кавычки
Возвращает
$this
enableForeignKeySQL()source public
enableForeignKeySQL( )
Возвращает SQL для включения внешних ключей.
Возвращает
stringenabled()source public
enabled( )
Возвращает, может ли php использовать этот драйвер для подключения к базе данных.
Возвращает
booleanИстина, если этот драйвер допустимо использовать.
getConnection()source public
getConnection( )
Возвращает правильный ресурс или объект соединения, используемый внутри.
Возвращает
objectВнутренний объект соединения.
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 public
prepare( string|Cake\Database\Query $query )
Подготавливает SQL-запрос к выполнению.
Параметры
- string|
Cake\Database\Query$query - Запрос, который нужно преобразовать в подготовленный запрос.
Возвращает
Cake\Database\StatementInterfacequeryTranslator()source public
queryTranslator( string $type )
Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернет экземпляр объекта Query, преобразованного для соответствия специфике используемого диалекта SQL.
Параметры
- string
$type Тип запроса, который должен быть преобразован (select, insert, update, delete).
Возвращает
callablequote()source public
quote( mixed $value , string $type )
Возвращает значение в безопасном представлении для использования в строке запроса
Параметры
- mixed
$value - Значение для присвоения кавычек.
- string
$type - Тип, используемый для определения типа присвоения кавычек.
Возвращает
stringquoteIdentifier()source public
quoteIdentifier( string $identifier )
Присваивает кавычки базе данных (имя столбца, имя таблицы и т.д.) для безопасного использования в запросах, без риска использования зарезервированных слов.
Параметры
- string
$identifier - Выражение идентификатора, которое нужно присвоить кавычки.
Возвращает
stringreleaseSavePointSQL()source public
releaseSavePointSQL( string $name )
Получить SQL для освобождения точки сохранения.
Параметры
- string
$name - Имя таблицы.
Возвращает
stringrollbackSavePointSQL()source public
rollbackSavePointSQL( string $name )
Получить SQL для отката точки сохранения.
Параметры
- string
$name - Имя таблицы.
Возвращает
stringrollbackTransaction()source public
rollbackTransaction( )
Откатывает транзакцию.
Возвращает
booleanИстина при успехе, ложь в противном случае.
savePointSQL()source public
savePointSQL( string $name )
Получить SQL для создания точки сохранения.
Параметры
- string
$name - Имя таблицы.
Возвращает
stringschemaDialect()source public
schemaDialect( )
Получить диалект схемы.
Используется пакетом Cake\Database\Schema для отображения схемы и генерации схемы.
Если все таблицы, использующие этот драйвер, указывают свои собственные схемы, то это может вернуть null.
Возвращает
Cake\Database\Schema\BaseSchemaschemaValue()source public
schemaValue( mixed $value )
Убегает значения для использования в определениях схемы.
Параметры
- mixed
$value - Значение для убегания.
Возвращает
stringСтрока для использования в определениях схемы.
setConnection()source public
setConnection( object $connection )
Устанавливает внутренний объект соединения.
Параметры
- object
$connection - Экземпляр соединения.
Возвращает
$this
supportsDynamicConstraints()source public
supportsDynamicConstraints( )
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
Возвращает
booleanИстина, если драйвер поддерживает динамические ограничения.
supportsQuoting()source public
supportsQuoting( )
Проверяет, поддерживает ли драйвер присвоение кавычек.
Возвращает
booleansupportsSavePoints()source public
supportsSavePoints( )
Возвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций.
Возвращает
booleanИстина, если точки сохранения поддерживаются, ложь в противном случае.
© 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.8/class-Cake.Database.DriverInterface.html