Spec-Zone.ru › CakePHP 3.3

Класс SqliteSchema

Функции управления схемой/рефлексии для Sqlite

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

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

  • $_constraintsIdMap protected
    array

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

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

  • _driver

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

  • _convertColumn() protected
    Преобразование определения столбца в абстрактные типы.
  • _defaultValue() protected
    Обработка значения по умолчанию.
  • addConstraintSql() public
    Генерация SQL-запросов для добавления ограничений внешних ключей в таблицу
  • columnSql() public
    Генерация SQL-фрагмента для отдельного столбца в таблице.
  • constraintSql() public
    Генерация SQL-фрагментов для определения ограничений таблицы.
  • convertColumnDescription() public
    Преобразование результатов описания поля в абстрактные поля схемы.
  • convertForeignKeyDescription() public
    Преобразование описания внешнего ключа в ограничения объекта таблицы.
  • 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\Table $table )

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

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

Параметры

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-запросы для создания таблицы.
END_OF_DOCUMENT_MARKER

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 таблицы, содержащие последовательности

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

boolean

indexSql()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–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.3/class-Cake.Database.Schema.SqliteSchema.html

Spec-Zone.ru

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