Класс 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

Возвращает

строка

addConstraintSql()source abstract public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema

Экземпляр таблицы, для которого применяются ограничения внешнего ключа.

Возвращает

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

columnSql()source abstract public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema

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

строка $name

Имя столбца.

Возвращает

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

constraintSql()source abstract public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema

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

строка $name

Имя столбца.

Возвращает

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

convertColumnDescription()source abstract public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema

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

массив $row

Данные строки из describeColumnSql.

convertForeignKeyDescription()source abstract public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema

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

массив $row

Данные строки из describeForeignKeySql.

convertIndexDescription()source abstract public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema

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

массив $row

Данные строки из describeIndexSql.

convertOptionsDescription()source public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema

Экземпляр таблицы.

массив $row

Строка данных.

createTableSql()source abstract 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 abstract public

describeColumnSql( string $tableName , array $config )

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

Параметры

строка $tableName

Имя таблицы для получения информации.

массив $config

Настройка соединения.

Возвращает

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

describeForeignKeySql()source abstract public

describeForeignKeySql( string $tableName , array $config )

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

Параметры

строка $tableName

Имя таблицы для получения информации.

массив $config

Настройка соединения.

Возвращает

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

describeIndexSql()source abstract public

describeIndexSql( string $tableName , array $config )

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

Параметры

строка $tableName

Имя таблицы для получения информации.

массив $config

Настройка соединения.

Возвращает

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

describeOptionsSql()source public

describeOptionsSql( string $tableName , array $config )

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

Параметры

строка $tableName

Имя таблицы.

массив $config

Настройка соединения.

Возвращает

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

dropConstraintSql()source abstract public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema

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

Возвращает

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

dropTableSql()source public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema

Экземпляр схемы

Возвращает

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

indexSql()source abstract public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema

Объект таблицы, в которой находится столбец.

строка $name

Имя столбца.

Возвращает

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

listTablesSql()source abstract public

listTablesSql( array $config )

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

Параметры

массив $config

Конфигурация соединения, используемая для получения таблиц.

Возвращает

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

truncateTableSql()source abstract public

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

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

Параметры

Cake\Database\Schema\TableSchema $schema

Экземпляр таблицы.

Возвращает

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