Spec-Zone.ru › CakePHP 3.6

Класс SqliteSchema

Функции управления и отражения схем для Sqlite

Cake\Database\Schema\BaseSchema
Extended by Cake\Database\Schema\SqliteSchema
Пространство имён: Cake\Database\Schema
Расположение: Database/Schema/SqliteSchema.php

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

  • $_constraintsIdMap protected
    array

    Массив, содержащий имена ограничений внешних ключей. Необходим для обработки составных внешних ключей

  • $_hasSequences protected
    boolean
    Есть ли в этом подключении к SQLite таблицы, содержащие последовательности.

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

  • _driver

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

  • _convertColumn() protected
    Преобразование определения столбца к абстрактным типам.
  • _defaultValue() protected
    Обработка значения по умолчанию.
  • addConstraintSql() public
    Генерация SQL-запросов для добавления ограничений внешних ключей в таблицу
  • columnSql() public
    Генерация SQL-фрагмента для отдельного столбца в таблице.
  • constraintSql() public
    Генерация SQL-фрагментов для определения ограничений таблицы.
  • convertColumnDescription() public
    Преобразование результатов описания поля в абстрактные поля схемы.
  • convertForeignKeyDescription() public
    Преобразование описания внешнего ключа в ограничения объекта Table.
  • convertIndexDescription() public
    Преобразование результатов описания индекса в абстрактные индексы или ограничения схемы.
  • createTableSql() public
    Генерация SQL для создания таблицы.
  • describeColumnSql() public
    Генерация SQL для описания таблицы.
  • describeForeignKeySql() public
    Генерация SQL для описания внешних ключей в таблице.
  • describeIndexSql() public
    Генерация SQL для описания индексов в таблице.
  • dropConstraintSql() public
    Генерация SQL-запросов для удаления ограничений внешних ключей из таблицы
  • hasSequences() public

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

  • indexSql() public
    Генерация SQL-фрагмента для отдельного индекса в таблице.
  • listTablesSql() public
    Генерация SQL для вывода списка таблиц.
  • truncateTableSql() public
    Генерация SQL для усечения таблицы.

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

_convertColumn()source protected

_convertColumn( string $column )

Преобразование определения столбца к абстрактным типам.

Возвращаемый тип будет типом, который может обработать Cake\Database\Type.

Параметры

строка $column
Тип столбца + длина

Возвращает

массив
Массив информации о столбце.

Исключения

Cake\Database\Exception
при невозможности разобрать тип столбца

_defaultValue()source protected

_defaultValue( string|null $default )

Обработка значения по умолчанию.

Sqlite включает кавычки и бары NULL в значениях по умолчанию. Нам нужно их удалить.

Параметры

строка|null $default
Значение по умолчанию.

Возвращает

строка|null

addConstraintSql()source public

addConstraintSql( Cake\Database\Schema\TableSchema $schema )

Генерация SQL-запросов для добавления ограничений внешних ключей в таблицу

SQLite не может правильно обработать добавление ограничения к существующей таблице. Этот метод является пустым

Параметры

Cake\Database\Schema\TableSchema $schema
Экземпляр таблицы, для которого нужно добавить ограничения внешних ключей.

Возвращает

массив
SQL-фрагмент.

columnSql()source public

columnSql( Cake\Database\Schema\TableSchema $schema , string $name )

Генерация SQL-фрагмента для отдельного столбца в таблице.

Параметры

Cake\Database\Schema\TableSchema $schema
Экземпляр таблицы, в которой находится столбец.
строка $name
Имя столбца.

Возвращает

строка
SQL-фрагмент.

Исключения

Cake\Database\Exception
когда тип столбца неизвестен

constraintSql()source public

constraintSql( Cake\Database\Schema\TableSchema $schema , string $name )

Генерация SQL-фрагментов для определения ограничений таблицы.

Обратите внимание, что целые первичные ключи вернут ''. Это сделано намеренно, так как Sqlite требует, чтобы целые первичные ключи были определены в определении столбца.

Параметры

Cake\Database\Schema\TableSchema $schema
Экземпляр таблицы, в которой находится столбец.
строка $name
Имя столбца.

Возвращает

строка
SQL-фрагмент.

convertColumnDescription()source public

convertColumnDescription( Cake\Database\Schema\TableSchema $schema , array $row )

Преобразование результатов описания поля в абстрактные поля схемы.

Параметры

Cake\Database\Schema\TableSchema $schema
Объект таблицы, к которому нужно добавить поля.
массив $row
Данные строки из describeColumnSql.

convertForeignKeyDescription()source public

convertForeignKeyDescription( Cake\Database\Schema\TableSchema $schema , array $row )

Преобразование описания внешнего ключа в ограничения объекта Table.

Параметры

Cake\Database\Schema\TableSchema $schema

Объект таблицы, к которому нужно добавить ограничение.

массив $row
Данные строки из describeForeignKeySql.

convertIndexDescription()source public

convertIndexDescription( Cake\Database\Schema\TableSchema $schema , array $row )

Преобразование результатов описания индекса в абстрактные индексы или ограничения схемы.

Поскольку в SQLite нет способа получить метаданные обо всех индексах сразу, здесь выполняются дополнительные запросы. Имена ограничений SQLite не стабильны, и имена ограничений не будут соответствовать тем, которые использовались для создания таблицы. Это ограничение в возможностях метаданных SQLite.

Параметры

Cake\Database\Schema\TableSchema $schema

Объект таблицы, к которому нужно добавить индекс или ограничение.

массив $row
Данные строки из describeIndexSql.
END_OF_DOCUMENT_MARKER

createTableSql()source public

createTableSql( Cake\Database\Schema\TableSchema $schema , array $columns , array $constraints , array $indexes )

Сгенерировать SQL для создания таблицы.

Параметры

Cake\Database\Schema\TableSchema $schema
Экземпляр таблицы.
массив $columns
Столбцы, которые нужно добавить в таблицу.
массив $constraints
Ограничения для таблицы.
массив $indexes
Индексы для таблицы.

Возвращает

массив
SQL-запросы для создания таблицы.

describeColumnSql()source public

describeColumnSql( string $tableName , array $config )

Сгенерировать SQL для описания таблицы.

Параметры

строка $tableName
Имя таблицы, для которой необходимо получить информацию.
массив $config
Настройки подключения.

Возвращает

массив
Массив (sql, params) для выполнения.

describeForeignKeySql()source public

describeForeignKeySql( string $tableName , array $config )

Сгенерировать SQL для описания внешних ключей в таблице.

Параметры

строка $tableName
Имя таблицы, для которой необходимо получить информацию.
массив $config
Настройки подключения.

Возвращает

массив
Массив (sql, params) для выполнения.

describeIndexSql()source public

describeIndexSql( string $tableName , array $config )

Сгенерировать SQL для описания индексов в таблице.

Параметры

строка $tableName
Имя таблицы, для которой необходимо получить информацию.
массив $config
Настройки подключения.

Возвращает

массив
Массив (sql, params) для выполнения.

dropConstraintSql()source public

dropConstraintSql( Cake\Database\Schema\TableSchema $schema )

Сгенерировать SQL-запросы для удаления ограничений внешних ключей из таблицы.

SQLite не может корректно обработать удаление ограничения для существующей таблицы. Этот метод ничего не делает (no-op).

Параметры

Cake\Database\Schema\TableSchema $schema
Экземпляр таблицы, к которому относятся ограничения внешних ключей.

Возвращает

массив
SQL-фрагмент.

hasSequences()source public

hasSequences( )

Возвращает, есть ли в этом подключении к SQLite таблицы, содержащие последовательности.

Возвращает

булево значение

indexSql()source public

indexSql( Cake\Database\Schema\TableSchema $schema , string $name )

Сгенерировать SQL-фрагмент для отдельного индекса в таблице.

Параметры

Cake\Database\Schema\TableSchema $schema
Объект таблицы, в которой находится столбец.
строка $name
Имя столбца.

Возвращает

строка
SQL-фрагмент.

listTablesSql()source public

listTablesSql( array $config )

Сгенерировать SQL для перечисления таблиц.

Параметры

массив $config

Настройки подключения, которые нужно использовать для получения таблиц.

Возвращает

массив
Массив (sql, params) для выполнения.

truncateTableSql()source public

truncateTableSql( Cake\Database\Schema\TableSchema $schema )

Сгенерировать SQL для обнуления таблицы.

Параметры

Cake\Database\Schema\TableSchema $schema
Экземпляр таблицы.

Возвращает

массив
SQL-запросы для обнуления таблицы.

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

__construct()source public

__construct( Cake\Database\Driver $driver )

Конструктор

Этот конструктор подключит драйвер, поэтому методы, такие как columnSql(), и другие, завершатся ошибкой, если драйвер не подключен.

Параметры

Cake\Database\Driver $driver
Используемый драйвер.

_convertConstraintColumns()source protected

_convertConstraintColumns( string|array $references )

Преобразовать ссылки на ограничения внешних ключей в корректный строковый список.

Параметры

строка|массив $references
Столбцы, на которые ссылается ограничение внешнего ключа.

Возвращает

строка

_convertOnClause()source protected

_convertOnClause( string $clause )

Преобразовать строковые фразы ON в абстрактные.

Параметры

строка $clause
Фраза ON для преобразования.

Возвращает

строка|null

_foreignOnClause()source protected

_foreignOnClause( string|null $on )

Сгенерировать фрагмент ON для внешнего ключа.

Параметры

строка|null $on
Фраза ON.

Возвращает

строка

convertOptionsDescription()source public

convertOptionsDescription( Cake\Database\Schema\TableSchema $schema , array $row )

Преобразовать данные опций в опции таблицы.

Параметры

Cake\Database\Schema\TableSchema $schema
Экземпляр таблицы.
массив $row
Строка данных.

describeOptionsSql()source public

describeOptionsSql( string $tableName , array $config )

Сгенерировать SQL для описания параметров таблицы.

Параметры

строка $tableName
Имя таблицы.
массив $config
Настройки подключения.

Возвращает

массив
SQL-запросы для получения параметров таблицы.

dropTableSql()source public

dropTableSql( Cake\Database\Schema\TableSchema $schema )

Сгенерировать SQL для удаления таблицы.

Параметры

Cake\Database\Schema\TableSchema $schema
Экземпляр схемы.

Возвращает

массив
SQL-запросы для удаления таблицы.

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

$_constraintsIdMapsource

protected массив

Массив, содержащий имена ограничений внешних ключей. Необходим для обработки составных внешних ключей.

[]

$_hasSequencessource

protected булево значение

Указывает, есть ли в этом подключении к SQLite таблицы, содержащие последовательности.

© 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.Schema.SqliteSchema.html

Spec-Zone.ru

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