Spec-Zone.ru › CakePHP 3.8

Класс Sqlite

Класс Sqlite

Cake\Database\Driver implements Cake\Database\DriverInterface
Расширенный Cake\Database\Driver\Sqlite использует Cake\Database\Dialect\SqliteDialectTrait
Пространство имён: Cake\Database\Driver
Расположение: Database/Driver/Sqlite.php

Краткое описание свойств

  • $_baseConfig protected
    array
    Базовые настройки конфигурации для драйвера Sqlite

Унаследованные свойства

  • _autoQuoting, _config, _connection _dateParts, _endQuote, _schemaDialect, _startQuote

Краткое описание методов

  • connect() public
    Устанавливает соединение с сервером базы данных
  • enabled() public
    Возвращает, может ли php использовать этот драйвер для подключения к базе данных
  • prepare() public
    Подготавливает SQL-запрос для выполнения
  • supportsDynamicConstraints() public

    Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.

Подробное описание методов

connect()source public

connect( )

Устанавливает соединение с сервером базы данных

Возвращаемое значение

boolean
true при успехе

enabled()source public

enabled( )

Возвращает, может ли php использовать этот драйвер для подключения к базе данных

Возвращаемое значение

boolean
true, если этот драйвер можно использовать

prepare()source public

prepare( string|Cake\Database\Query $query )

Подготавливает SQL-запрос для выполнения

Параметры

строка|Cake\Database\Query $query
Запрос для подготовки.

Возвращаемое значение

Cake\Database\StatementInterface

Переопределяет

Cake\Database\Driver::prepare()

supportsDynamicConstraints()source public

supportsDynamicConstraints( )

Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.

Возвращаемое значение

boolean
true, если драйвер поддерживает динамические ограничения.

Методы, унаследованные от Cake\Database\Driver

__construct()source public

__construct( array $config = [] )

Конструктор

Параметры

массив $config необязательно []
Конфигурация для драйвера.

Исключения

InvalidArgumentException

__debugInfo()source public

__debugInfo( )

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращаемое значение

массив

__destruct()source public

__destruct( )

Деструктор

_connect()source protected

_connect( string $dsn , array $config )

Устанавливает соединение с сервером базы данных

Параметры

строка $dsn
Драйвер-специфический PDO-DSN
массив $config
конфигурация, которая будет использоваться для создания подключения

Возвращаемое значение

boolean
true при успехе

autoQuoting()source public deprecated

autoQuoting( boolean|null $enable = null )

Возвращает, будет ли этот драйвер автоматически заключать идентификаторы в запросах

Если вызвано с булевым аргументом, оно переключит настройку автоматического заключения в переданное значение

Устарело

3.4.0 использовать enableAutoQuoting()/isAutoQuotingEnabled() вместо этого.

Параметры

boolean|null $enable необязательно null
Включить или выключить автоматическое заключение

Возвращаемое значение

boolean

beginTransaction()source public

beginTransaction( )

Начинает транзакцию.

Возвращаемое значение

boolean
True при успехе, иначе false.

Реализация

Cake\Database\DriverInterface::beginTransaction()

commitTransaction()source public

commitTransaction( )

Подтверждает транзакцию.

Возвращаемое значение

boolean
True при успехе, иначе false.

Реализация

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
Используемый значение-биндер.

Возвращаемое значение

массив

содержащий 2 записи. Первый элемент - преобразованный запрос, а второй - скомпилированная строка SQL.


Реализация

Cake\Database\DriverInterface::compileQuery()

connection()source public deprecated

connection( mixed $connection = null )

Возвращает правильный ресурс или объект подключения, который используется внутри. Если первый аргумент передан, он установит внутренний объект подключения или результат в переданное значение.

Устарело

3.6.0 Используйте getConnection()/setConnection() вместо этого.

Параметры

смешанный $connection необязательно null
Экземпляр подключения PDO.

Возвращаемое значение

смешанный
Внутренне используемый объект подключения.

disableAutoQuoting()source public

disableAutoQuoting( )

Отключает автоматическое заключение идентификаторов в запросах.

Возвращаемое значение


$this

disableForeignKeySQL()source abstract public

disableForeignKeySQL( )

Получает SQL для отключения внешних ключей.

Возвращаемое значение

строка

Реализация

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()

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 optional null
Имя таблицы или последовательности, чтобы получить последнее значение вставки.
string|null $column optional null
Имя столбца, представляющего первичный ключ.

Возвращает

string|integer

Реализация

Cake\Database\DriverInterface::lastInsertId()

newCompiler()source public

newCompiler( )

Возвращает экземпляр QueryCompiler.

Возвращает

Cake\Database\QueryCompiler

Реализация

Cake\Database\DriverInterface::newCompiler()

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()

supportsQuoting()source public

supportsQuoting( )

Проверяет, поддерживает ли драйвер приведение к кавычкам, так как PDO_ODBC его не поддерживает.

Возвращает

boolean

Реализация

Cake\Database\DriverInterface::supportsQuoting()

supportsSavePoints()source public

supportsSavePoints( )

Возвращает, поддерживает ли этот драйвер сохраняемые точки для вложенных транзакций.

Возвращает

boolean
True, если сохраняемые точки поддерживаются, false в противном случае.

Реализация

Cake\Database\DriverInterface::supportsSavePoints()

Методы, используемые из Cake\Database\Dialect\SqliteDialectTrait

_expressionTranslators()source protected

_expressionTranslators( )

Возвращает словарь выражений, которые будут преобразовываться при компиляции запроса в SQL. Ключи массива — имена методов, которые будут вызываться в этом классе

Возвращает

array

_transformFunctionExpression()source protected

_transformFunctionExpression( Cake\Database\Expression\FunctionExpression $expression )

Принимает FunctionExpression и изменяет его так, чтобы он соответствовал этому диалекту SQL.

Параметры

Cake\Database\Expression\FunctionExpression $expression

Выражение функции, подлежащее переводу для SQLite.

END_OF_DOCUMENT_MARKER

disableForeignKeySQL()source public

disableForeignKeySQL( )

enableForeignKeySQL()source public

enableForeignKeySQL( )

newCompiler()source public

newCompiler( )

Возвращает

Cake\Database\SqliteCompiler

schemaDialect()source public

schemaDialect( )

Получить диалект схемы.

Используется пакетом Cake\Database\Schema для отражения схемы и генерации схемы.

Возвращает

Cake\Database\Schema\SqliteSchema

Подробности свойств

$_baseConfigsource

protected массив

Основные параметры конфигурации для драйвера Sqlite

  • mask Маска, используемая для создания базы данных
[
    'persistent' => false,
    'username' => null,
    'password' => null,
    'database' => ':memory:',
    'encoding' => 'utf8',
    'mask' => 0644,
    'flags' => [],
    'init' => [],
]

© 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.Driver.Sqlite.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API