Класс Sqlite
Класс Sqlite
Константы
-
int|nullMAX_ALIAS_LENGTHnull
-
int[]RETRY_ERROR_CODES[]
Краткое описание свойств
- $_autoQuoting protected
boolУказывает, выполняет ли драйвер автоматическое цитирование идентификаторов для всех запросов
- $_baseConfig protected
arrayОсновные параметры конфигурации для драйвера Sqlite
- $_config protected
arrayДанные конфигурации.
- $_connection protected
PDOЭкземпляр PDO.
- $_dateParts protected
arrayСопоставление частей даты.
- $_endQuote protected
stringСтрока, используемая для завершения цитирования идентификатора базы данных для обеспечения безопасности
- $_schemaDialect protected
Cake\Database\Schema\SqliteSchemaDialect|nullКласс диалекта схемы для этого драйвера
- $_startQuote protected
stringСтрока, используемая для начала цитирования идентификатора базы данных для обеспечения безопасности
- $_supportsWindowFunctions protected
bool|nullПоддерживает ли подключённый сервер функции окон.
- $_version protected
string|nullВерсия сервера
- $connectRetries protected
intПоследнее количество попыток повторного подключения.
- $supportsCTEs protected
bool|nullПоддерживает ли сервер выражения общих таблиц.
Краткое описание методов
-
__construct() public
Конструктор
-
__debugInfo() public
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
-
__destruct() public
Деструктор
-
_connect() protected
Устанавливает соединение с сервером базы данных
-
_deleteQueryTranslator() protected
Применяет шаги трансляции к запросам удаления.
-
_expressionTranslators() protected
Возвращает ассоциативный массив методов, которые будут преобразовывать объекты Expression для соответствия конкретному диалекту SQL. Ключи — имена классов, значения — методы в этом классе.
-
_insertQueryTranslator() protected
Применяет шаги трансляции к запросам вставки.
-
_removeAliasesFromConditions() protected
Удаляет псевдонимы из
WHEREусловия запроса. -
_selectQueryTranslator() protected
Применяет шаги трансляции к запросам выбора.
-
_transformDistinct() protected
Возвращает переданный запрос после переписывания условия DISTINCT, чтобы драйверы, не поддерживающие часть «ON», могли указать, как это должно быть сделано.
-
_transformFunctionExpression() protected
Получает FunctionExpression и изменяет его так, чтобы он соответствовал этому диалекту SQL.
-
_transformTupleComparison() protected
Получает TupleExpression и изменяет его так, чтобы он соответствовал этому диалекту SQL.
-
_updateQueryTranslator() protected
Применяет шаги трансляции к запросам обновления.
-
beginTransaction() public
Начинает транзакцию.
-
commitTransaction() public
Подтверждает транзакцию.
-
compileQuery() public
Преобразует переданный запрос в диалект этого драйвера и возвращает экземпляр преобразованного запроса и полную скомпилированную строку SQL.
-
connect() public
Устанавливает соединение с сервером базы данных
-
disableAutoQuoting() public
Отключает автоматическое экранирование идентификаторов в запросах.
-
disableForeignKeySQL() public
Получает SQL для отключения внешних ключей.
-
disconnect() public
Отключается от сервера базы данных.
-
enableAutoQuoting() public
Устанавливает, должен ли этот драйвер автоматически экранировать идентификаторы в запросах.
-
enableForeignKeySQL() public
Получает SQL для включения внешних ключей.
-
enabled() public
Возвращает, может ли php использовать этот драйвер для подключения к базе данных.
-
getConnectRetries() public
Возвращает количество попыток повторного подключения.
-
getConnection() public
Получает внутренний экземпляр подключения PDO.
-
getMaxAliasLength() public
Возвращает максимальную длину псевдонима. Она может отличаться от максимальной длины идентификатора столбцов.
-
isAutoQuotingEnabled() public
Возвращает, должен ли этот драйвер автоматически экранировать идентификаторы в запросах.
-
isConnected() public
Проверяет, подключен ли драйвер.
-
lastInsertId() public
Возвращает последний сгенерированный ID для таблицы или последовательности в базе данных.
-
newCompiler() public
Возвращает экземпляр QueryCompiler.
-
newTableSchema() public
Создает новую TableSchema.
-
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
Устанавливает внутренний экземпляр подключения PDO.
-
supportsCTEs() public
Возвращает true, если сервер поддерживает общие табличные выражения.
-
supportsDynamicConstraints() public
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
-
supportsQuoting() public
Проверяет, поддерживает ли драйвер цитирование, так как PDO_ODBC его не поддерживает.
-
supportsSavePoints() public
Возвращает, поддерживает ли данный драйвер сохранение точек для вложенных транзакций.
-
supportsWindowFunctions() public
Возвращает true, если подключенный сервер поддерживает оконные функции.
-
version() public
Возвращает версию подключенного сервера.
Подробное описание методов
__construct() public
__construct(array $config = [])
Конструктор
Параметры
-
array$config необязательный Конфигурация драйвера.
Исключения
InvalidArgumentException__debugInfo() public
__debugInfo(): array
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
array__destruct() public
__destruct()
Деструктор
_connect() protected
_connect(string $dsn, array $config): bool
Устанавливает подключение к серверу базы данных
Параметры
-
string$dsn Спецификация подключения (DSN) для PDO драйвера.
-
array$config Конфигурация, используемая для создания подключения.
Возвращает
bool_deleteQueryTranslator() protected
_deleteQueryTranslator(Cake\Database\Query $query): Cake\Database\Query
Применяет шаги трансляции к запросам удаления.
Удаляет псевдонимы из условий запроса удаления, так как большинство диалектов баз данных не поддерживают псевдонимы в запросах удаления. Также удаляются псевдонимы в именах таблиц, так как они часто тоже не работают.
Мы намеренно не поддерживаем удаления с объединениями, так как они имеют еще меньшую поддержку.
Параметры
-
Cake\Database\Query$query Запрос для трансляции
Возвращает
Cake\Database\Query_expressionTranslators() protected
_expressionTranslators(): string[]
Возвращает ассоциативный массив методов, которые преобразуют объекты Expression для соответствия конкретному диалекту SQL. Ключи — имена классов, значения — метод в этом классе.
Возвращает
string[]_insertQueryTranslator() protected
_insertQueryTranslator(Cake\Database\Query $query): Cake\Database\Query
Применяет шаги трансляции к запросам вставки.
Параметры
-
Cake\Database\Query$query Запрос для трансляции
Возвращает
Cake\Database\Query_removeAliasesFromConditions() protected
_removeAliasesFromConditions(Cake\Database\Query $query): Cake\Database\Query
Удаляет псевдонимы из условия WHERE запроса.
Параметры
-
Cake\Database\Query$query Запрос для обработки.
Возвращает
Cake\Database\QueryИсключения
RuntimeExceptionВ случае, если обработанный запрос содержит какие-либо объединения, так как удаление псевдонимов из условий может нарушить ссылки на соединенные таблицы.
_selectQueryTranslator() protected
_selectQueryTranslator(Cake\Database\Query $query): Cake\Database\Query
Применяет шаги трансляции к запросам выбора.
Параметры
-
Cake\Database\Query$query Запрос для трансляции
Возвращает
Cake\Database\Query_transformDistinct() protected
_transformDistinct(Cake\Database\Query $query): Cake\Database\Query
Возвращает переданный запрос после переработки условия DISTINCT, таким образом, драйверы, которые не поддерживают часть "ON", могут предоставить фактический способ, как это должно быть сделано.
Параметры
-
Cake\Database\Query$query Запрос для преобразования
Возвращает
Cake\Database\Query_transformFunctionExpression() protected
_transformFunctionExpression(Cake\Database\Expression\FunctionExpression $expression): void
Принимает FunctionExpression и изменяет его так, чтобы он соответствовал этому диалекту SQL.
Параметры
-
Cake\Database\Expression\FunctionExpression$expression Функциональное выражение для преобразования в TSQL.
Возвращает
void_transformTupleComparison() protected
_transformTupleComparison(Cake\Database\Expression\TupleComparison $expression, Cake\Database\Query $query): void
Принимает TupleExpression и изменяет его так, чтобы он соответствовал этому диалекту SQL.
Преобразует выражения, похожие на '(a, b) IN ((c, d), (e, f))' в эквивалентное выражение вида '((a = c) AND (b = d)) OR ((a = e) AND (b = f))'.
Также может преобразовывать выражения, где правая часть — запрос, выбирающий такое же количество столбцов, как элементы в левой части выражения:
(a, b) IN (SELECT c, d FROM a_table) преобразуется в
1 = (SELECT 1 FROM a_table WHERE (a = c) AND (b = d))
Параметры
-
Cake\Database\Expression\TupleComparison$expression Выражение для преобразования
-
Cake\Database\Query$query Запрос для обновления.
Возвращает
void_updateQueryTranslator() protected
_updateQueryTranslator(Cake\Database\Query $query): Cake\Database\Query
Применяет шаги трансляции к запросам обновления.
Удаляет псевдонимы из условий запроса обновления, так как не все диалекты баз данных поддерживают псевдонимы в запросах обновления.
Так же, как и для запросов удаления, объединения в настоящее время не поддерживаются для запросов обновления.
Параметры
-
Cake\Database\Query$query Запрос для трансляции
Возвращает
Cake\Database\QuerybeginTransaction() public
beginTransaction(): bool
Начинает транзакцию.
Возвращает
boolcommitTransaction() public
commitTransaction(): bool
Завершает транзакцию.
Возвращает
boolcompileQuery() public
compileQuery(Cake\Database\Query $query, Cake\Database\ValueBinder $binder): array
Преобразует переданный запрос в диалект этого драйвера и возвращает экземпляр преобразованного запроса и полную скомпилированную строку SQL.
Параметры
-
Cake\Database\Query$query -
Cake\Database\ValueBinder$binder
Возвращает
arrayconnect() public
connect(): bool
Устанавливает подключение к серверу базы данных
Возвращает
booldisableAutoQuoting() public
disableAutoQuoting(): $this
Отключает автоматическое цитирование идентификаторов в запросах.
Возвращает
$thisdisableForeignKeySQL() public
disableForeignKeySQL(): string
Получает SQL-код для отключения внешних ключей.
Возвращает
stringdisconnect() public
disconnect(): void
Отключается от сервера базы данных.
Возвращает
voidenableAutoQuoting() public
enableAutoQuoting(bool $enable = true): $this
Устанавливает, нужно ли этому драйверу автоматически цитировать идентификаторы в запросах.
Параметры
-
bool$enable необязательный
Возвращает
$thisenableForeignKeySQL() public
enableForeignKeySQL(): string
Получает SQL-код для включения внешних ключей.
Возвращает
stringenabled() public
enabled(): bool
Возвращает, может ли php использовать этот драйвер для подключения к базе данных
Возвращает
boolgetConnectRetries() public
getConnectRetries(): int
Возвращает количество попыток повторного подключения.
Возвращает
intgetConnection() public
getConnection(): PDO
Получить внутренний экземпляр соединения PDO.
Возвращает
PDOgetMaxAliasLength() public
getMaxAliasLength(): int|null
Возвращает максимальную длину псевдонима. Она может отличаться от максимальной длины идентификатора столбца.
Возвращает
int|nullisAutoQuotingEnabled() public
isAutoQuotingEnabled(): bool
Возвращает, автоматически ли драйвер приводит идентификаторы в кавычки в запросах.
Возвращает
boolisConnected() public
isConnected(): bool
Проверяет, подключен ли драйвер.
Возвращает
boollastInsertId() public
lastInsertId(string|null $table = null, string|null $column = null): string|int
Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных.
Параметры
-
string|null$table необязательный -
string|null$column необязательный
Возвращает
string|intnewCompiler() public
newCompiler(): Cake\Database\QueryCompiler
Возвращает экземпляр QueryCompiler.
Возвращает
Cake\Database\QueryCompilernewTableSchema() public
newTableSchema(string $table, array $columns = []): Cake\Database\Schema\TableSchema
Создаёт новый TableSchema.
Параметры
-
string$table -
array$columns необязательный
Возвращает
Cake\Database\Schema\TableSchemaprepare() public
prepare(stringCake\Database\Query $query): Cake\Database\StatementInterface
Подготавливает SQL-запрос для выполнения.
Параметры
-
stringCake\Database\Query$query Запрос для подготовки.
Возвращает
Cake\Database\StatementInterfacequeryTranslator() public
queryTranslator(string $type): Closure
Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернёт экземпляр объекта Query, преобразованного в соответствии со спецификой используемого диалекта SQL.
Параметры
-
string$type тип запроса для преобразования (select, insert, update, delete)
Возвращает
Closurequote() public
quote(mixed $value, int $type = PDO::PARAM_STR): string
Возвращает значение в безопасном представлении для использования в строке запроса.
Параметры
-
mixed$value -
int$type необязательный
Возвращает
stringquoteIdentifier() public
quoteIdentifier(string $identifier): string
Приводит имя базы данных (имя столбца, имя таблицы и т. д.) в кавычки для безопасного использования в запросах, без риска использования зарезервированных слов.
Параметры
-
string$identifier Идентификатор для приведения в кавычки.
Возвращает
stringreleaseSavePointSQL() public
releaseSavePointSQL(string|int $name): string
Возвращает SQL-фрагмент для освобождения ранее созданной точки сохранения.
Параметры
-
string|int$name имя точки сохранения
Возвращает
stringrollbackSavePointSQL() public
rollbackSavePointSQL(string|int $name): string
Возвращает SQL-фрагмент для отката ранее созданной точки сохранения.
Параметры
-
string|int$name имя точки сохранения
Возвращает
stringrollbackTransaction() public
rollbackTransaction(): bool
Откатывает транзакцию.
Возвращает
boolsavePointSQL() public
savePointSQL(string|int $name): string
Возвращает SQL-фрагмент для создания новой точки сохранения транзакции.
Параметры
-
string|int$name имя точки сохранения
Возвращает
stringschema() public
schema(): string
Возвращает имя схемы, используемой в данный момент.
Возвращает
stringschemaDialect() public
schemaDialect(): Cake\Database\Schema\SchemaDialect
Получить диалект схемы.
Используется пакетом Cake\Database\Schema для отражения схемы и генерации схемы.
Если все таблицы, использующие этот драйвер, указывают свои собственные схемы, то это может вернуть null.
Возвращает
Cake\Database\Schema\SchemaDialectschemaValue() public
schemaValue(mixed $value): string
Экранирует значения для использования в определениях схем.
Параметры
-
mixed$value
Возвращает
stringsetConnection() public
setConnection(object $connection): $this
Установить внутренний экземпляр соединения PDO.
Параметры
-
object$connection экземпляр PDO.
Возвращает
$thissupportsCTEs() public
supportsCTEs(): bool
Возвращает true, если сервер поддерживает выражения с общими таблицами.
Возвращает
boolsupportsDynamicConstraints() public
supportsDynamicConstraints(): bool
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
Возвращает
boolsupportsQuoting() public
supportsQuoting(): bool
Проверяет, поддерживает ли драйвер приведение в кавычки. PDO_ODBC, например, не поддерживает.
Возвращает
boolsupportsSavePoints() public
supportsSavePoints(): bool
Возвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций.
Возвращает
boolsupportsWindowFunctions() public
supportsWindowFunctions(): bool
Возвращает true, если подключённый сервер поддерживает оконные функции.
Возвращает
boolversion() public
version(): string
Возвращает версию подключенного сервера.
Возвращает
stringПодробное описание свойства
$_autoQuoting protected
Указывает, выполняет ли драйвер автоматическое цитирование идентификаторов для всех запросов
Тип
bool$_baseConfig protected
Базовые параметры конфигурации для драйвера Sqlite
-
maskИспользуемая маска для созданной базы данных
Тип
array$_config protected
Данные конфигурации.
Тип
array$_connection protected
Экземпляр PDO.
Тип
PDO$_dateParts protected
Сопоставление частей даты.
Тип
array$_endQuote protected
Строка, используемая для завершения цитирования идентификатора базы данных для обеспечения безопасности
Тип
string$_schemaDialect protected
Класс диалекта схемы для этого драйвера
Тип
Cake\Database\Schema\SqliteSchemaDialect|null$_startQuote protected
Строка, используемая для начала цитирования идентификатора базы данных для обеспечения безопасности
Тип
string$_supportsWindowFunctions protected
Поддерживает ли подключённый сервер оконные функции.
Тип
bool|null$_version protected
Версия сервера
Тип
string|null$connectRetries protected
Последнее количество попыток повторного подключения.
Тип
int$supportsCTEs protected
Поддерживает ли сервер выражения общих таблиц.
Тип
bool|null
© 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/4.2/class-Cake.Database.Driver.Sqlite.html