Класс BaseSchema

__constructsource public

__construct( Cake\Database\Driver $driver )

Конструктор

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

Параметры

Cake\Database\Driver $driver

Используемый драйвер.

_convertConstraintColumnssource protected

_convertConstraintColumns( string|array $references )

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

Параметры

string|array $references

Ссылающиеся столбцы ограничения внешнего ключа.

Возвращает

string
string

_convertOnClausesource protected

_convertOnClause( string $clause )

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

Параметры

string $clause

Фрагмент ON для преобразования.

Возвращает

string|null
string|null

_foreignOnClausesource protected

_foreignOnClause( string|null $on )

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

Параметры

string|null $on

Фрагмент ON.

Возвращает

string
string

addConstraintSqlsource abstract public

addConstraintSql( Cake\Database\Schema\Table $table )

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

Параметры

Cake\Database\Schema\Table $table

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

Возвращает

array
SQL-фрагмент.

columnSqlsource abstract public

columnSql( Cake\Database\Schema\Table $table , string $name )

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

Параметры

Cake\Database\Schema\Table $table

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

string $name

Имя столбца.

Возвращает

string
SQL-фрагмент.

constraintSqlsource abstract public

constraintSql( Cake\Database\Schema\Table $table , string $name )

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

Параметры

Cake\Database\Schema\Table $table

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

string $name

Имя столбца.

Возвращает

string
SQL-фрагмент.

convertColumnDescriptionsource abstract public

convertColumnDescription( Cake\Database\Schema\Table $table , array $row )

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

Параметры

Cake\Database\Schema\Table $table

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

array $row

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

convertForeignKeyDescriptionsource abstract public

convertForeignKeyDescription( Cake\Database\Schema\Table $table , array $row )

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

Параметры

Cake\Database\Schema\Table $table

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

array $row

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

convertIndexDescriptionsource abstract public

convertIndexDescription( Cake\Database\Schema\Table $table , array $row )

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

Параметры

Cake\Database\Schema\Table $table

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

array $row

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

convertOptionsDescriptionsource public

convertOptionsDescription( Cake\Database\Schema\Table $table , array $row )

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

Параметры

Cake\Database\Schema\Table $table

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

array $row

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

createTableSqlsource abstract public

createTableSql( Cake\Database\Schema\Table $table , array $columns , array $constraints , array $indexes )

Генерирует SQL для создания таблицы.

Параметры

Cake\Database\Schema\Table $table

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

array $columns

Столбцы, которые нужно добавить в таблицу.

array $constraints

Ограничения для таблицы.

array $indexes

Индексы для таблицы.

Возвращает

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

describeColumnSqlsource abstract public

describeColumnSql( string $tableName , array $config )

Генерирует SQL для описания таблицы.

Параметры

string $tableName

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

array $config

Настройка подключения.

Возвращает

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

describeForeignKeySqlsource abstract public

describeForeignKeySql( string $tableName , array $config )

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

Параметры

string $tableName

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

array $config

Настройка подключения.

Возвращает

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

describeIndexSqlsource abstract public

describeIndexSql( string $tableName , array $config )

Генерирует SQL для описания индексов в таблице.

Параметры

string $tableName

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

array $config

Настройка подключения.

Возвращает

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

describeOptionsSqlsource public

describeOptionsSql( string $tableName , array $config )

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

Параметры

string $tableName

Имя таблицы.

array $config

Настройка подключения.

Возвращает

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

dropConstraintSqlsource абстрактный public

dropConstraintSql( Cake\Database\Schema\Table $table )

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

Параметры

Cake\Database\Schema\Table $table

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

Возвращает

array
SQL фрагмент.

dropTableSqlsource public

dropTableSql( Cake\Database\Schema\Table $table )

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

Параметры

Cake\Database\Schema\Table $table

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

Возвращает

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

indexSqlsource абстрактный public

indexSql( Cake\Database\Schema\Table $table , string $name )

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

Параметры

Cake\Database\Schema\Table $table

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

строка $name

Имя столбца.

Возвращает

string
SQL фрагмент.

listTablesSqlsource абстрактный public

listTablesSql( array $config )

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

Параметры

массив $config

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

Возвращает

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

truncateTableSqlsource абстрактный public

truncateTableSql( Cake\Database\Schema\Table $table )

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

Параметры

Cake\Database\Schema\Table $table

Объект таблицы.

Возвращает

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