Класс SqliteSchema
Функции управления/рефлексии схемой для Sqlite
- Cake\Database\Schema\BaseSchema
-
Cake\Database\Schema\SqliteSchema
Краткое описание свойств
-
$_constraintsIdMapprotectedarrayМассив, содержащий имена ограничений внешних ключей. Необходим для обработки составных внешних ключей
Унаследованные свойства
Краткое описание методов
- _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 включает кавычки и базовые NULL в значениях по умолчанию. Нам нужно их удалить.
Параметры
- строка|null
$default - Значение по умолчанию.
Возвращает
строка|nulladdConstraintSql()source public
addConstraintSql( Cake\Database\Schema\Table $table )
Генерировать SQL-запросы, необходимые для добавления ограничений внешнего ключа к таблице.
SQLite не может должным образом обработать добавление ограничения к существующей таблице. Этот метод является пустым (no-op).
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы, к которому относятся ограничения внешнего ключа.
Возвращает
массивSQL-фрагмент.
columnSql()source public
columnSql( Cake\Database\Schema\Table $table , string $name )
Сгенерировать SQL-фрагмент для одного столбца в таблице.
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы, в которой находится столбец.
- строка
$name - Имя столбца.
Возвращает
строкаSQL-фрагмент.
Исключения
Cake\Database\Exceptionпри неизвестном типе столбца
constraintSql()source public
constraintSql( Cake\Database\Schema\Table $table , string $name )
Сгенерировать SQL-фрагменты для определения ограничений таблицы.
Обратите внимание, что целые первичные ключи вернут ''. Это сделано намеренно, так как Sqlite требует, чтобы целые первичные ключи были определены в определении столбца.
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы, в которой находится столбец.
- строка
$name - Имя столбца.
Возвращает
строкаSQL-фрагмент.
convertColumnDescription()source public
convertColumnDescription( Cake\Database\Schema\Table $table , array $row )
Преобразовать результаты описания поля в абстрактные поля схемы.
Параметры
-
Cake\Database\Schema\Table$table - Объект таблицы, к которому необходимо добавить поля.
- массив
$row - Данные строки из
describeColumnSql.
convertForeignKeyDescription()source public
convertForeignKeyDescription( Cake\Database\Schema\Table $table , array $row )
Преобразовать описание внешнего ключа в ограничения в объекте таблицы.
Параметры
-
Cake\Database\Schema\Table$table Объект таблицы, к которому нужно добавить ограничение.
- массив
$row - Данные строки из
describeForeignKeySql.
convertIndexDescription()source public
convertIndexDescription( Cake\Database\Schema\Table $table , array $row )
Преобразовать результаты описания индекса в абстрактные индексы или ограничения схемы.
Поскольку SQLite не имеет способа получить метаданные обо всех индексах сразу, здесь выполняются дополнительные запросы. Имена ограничений SQLite нестабильны, и имена ограничений не будут совпадать с именами, используемыми для создания таблицы. Это ограничение функциональности метаданных SQLite.
Параметры
-
Cake\Database\Schema\Table$table Объект таблицы, к которому нужно добавить индекс или ограничение.
- массив
$row - Данные строки из
describeIndexSql.
createTableSql()source public
createTableSql( Cake\Database\Schema\Table $table , array $columns , array $constraints , array $indexes )
Сгенерировать SQL для создания таблицы.
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы.
- массив
$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\Table $table )
Генерировать SQL запросы для удаления ограничений внешних ключей из таблицы
SQLite не может правильно обработать удаление ограничения для существующей таблицы. Этот метод ничего не делает (no-op).
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы, для которого нужно удалить ограничения внешних ключей.
Возвращаемое значение
массивSQL фрагмент.
hasSequences()source public
hasSequences( )
Возвращает, есть ли в этом подключении к SQLite какие-либо таблицы, содержащие последовательности.
Возвращаемое значение
booleanindexSql()source public
indexSql( Cake\Database\Schema\Table $table , string $name )
Генерировать SQL фрагмент для отдельного индекса в таблице.
Параметры
-
Cake\Database\Schema\Table$table - Объект таблицы, в которой находится столбец.
- строка
$name - Имя столбца.
Возвращаемое значение
строкаSQL фрагмент.
listTablesSql()source public
listTablesSql( array $config )
Генерировать SQL для получения списка таблиц.
Параметры
- массив
$config Настройки подключения для получения таблиц.
Возвращаемое значение
массивМассив (sql, params) для выполнения.
truncateTableSql()source public
truncateTableSql( Cake\Database\Schema\Table $table )
Генерировать SQL для усечения таблицы.
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы.
Возвращаемое значение
массив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\Table $table , array $row )
Преобразовать данные опций в параметры таблицы.
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы.
- массив
$row - Строка данных.
describeOptionsSql()source public
describeOptionsSql( string $tableName , array $config )
Генерировать SQL для описания параметров таблицы
Параметры
- строка
$tableName - Имя таблицы.
- массив
$config - Настройки подключения.
Возвращаемое значение
массивSQL запросы для получения параметров таблицы.
dropTableSql()source public
dropTableSql( Cake\Database\Schema\Table $table )
Генерировать SQL для удаления таблицы.
Параметры
-
Cake\Database\Schema\Table$table - Экземпляр таблицы
Возвращаемое значение
массивSQL запросы для удаления таблицы.
Подробное описание свойств
$_constraintsIdMapsource
protected массив
Массив, содержащий имена ограничений внешних ключей. Необходим для обработки составных внешних ключей.
[]
© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Database.Schema.SqliteSchema.html