Класс SqliteSchema
Функции управления и отражения схемы для Sqlite
- Cake\Database\Schema\BaseSchema
-
Cake\Database\Schema\SqliteSchema
Краткое описание свойств
-
$_constraintsIdMapprotectedarrayМассив, содержащий имена ограничений внешних ключей. Необходим для обработки составных внешних ключей.
-
$_hasSequencesprotectedЕсть ли в этом соединении с SQLite таблицы, содержащие последовательности.boolean
Наследуемые свойства
Краткое описание методов
- _convertColumn() protectedПреобразование определения столбца в абстрактные типы.
- _defaultValue() protectedОбработка значения по умолчанию.
- addConstraintSql() publicГенерация SQL-запросов для добавления ограничений внешних ключей в таблицу
- columnSql() publicГенерация SQL-фрагмента для одного столбца в таблице.
- constraintSql() publicГенерация SQL-фрагментов для определения ограничений таблицы.
- convertColumnDescription() 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 включает кавычки и bared NULL в значениях по умолчанию. Нам нужно их удалить.
Параметры
- строка|null
$default - Значение по умолчанию.
Возвращает
строка|nulladdConstraintSql()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.
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 наличие таблиц с последовательностями.
Возвращает
booleanindexSql()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 boolean
Указывает, есть ли в этом подключении к SQLite таблицы, содержащие последовательности.
© 2005–2017 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.4/class-Cake.Database.Schema.SqliteSchema.html