Класс BaseSchema

__construct()source public

__construct( Cake\Database\Driver $driver )

Конструктор

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

Параметры

Cake\Database\Driver $driver

Драйвер для использования.

_convertConstraintColumns()source protected

_convertConstraintColumns( string|array $references )

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

Параметры

string|array $references

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

Возвращает

string

_convertOnClause()source protected

_convertOnClause( string $clause )

Преобразование строковых элементов on-определений к абстрактным.

Параметры

string $clause

Определение on-определения для преобразования.

Возвращает

string|null

_foreignOnClause()source protected

_foreignOnClause( string|null $on )

Генерация ON-определения для внешнего ключа.

Параметры

string|null $on

Определение on-определения.

Возвращает

string

addConstraintSql()source abstract public

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

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

Параметры

Cake\Database\Schema\Table $table

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

Возвращает

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

columnSql()source abstract public

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

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

Параметры

Cake\Database\Schema\Table $table

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

string $name

Имя столбца.

Возвращает

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

constraintSql()source abstract public

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

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

Параметры

Cake\Database\Schema\Table $table

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

string $name

Имя столбца.

Возвращает

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

convertColumnDescription()source abstract public

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

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

Параметры

Cake\Database\Schema\Table $table

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

array $row

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

convertForeignKeyDescription()source абстрактный общедоступный

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

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

Параметры

Cake\Database\Schema\Table $table

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

массив $row

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

convertIndexDescription()source абстрактный общедоступный

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

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

Параметры

Cake\Database\Schema\Table $table

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

массив $row

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

convertOptionsDescription()source общедоступный

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

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

Параметры

Cake\Database\Schema\Table $table

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

массив $row

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

createTableSql()source абстрактный общедоступный

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

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

Параметры

Cake\Database\Schema\Table $table

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

массив $columns

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

массив $constraints

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

массив $indexes

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

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

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

describeColumnSql()source абстрактный общедоступный

describeColumnSql( string $tableName , array $config )

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

Параметры

строка $tableName

Имя таблицы, информация о которой требуется.

массив $config

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

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

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

describeForeignKeySql()source абстрактный общедоступный

describeForeignKeySql( string $tableName , array $config )

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

Параметры

строка $tableName

Имя таблицы, информация о которой требуется.

массив $config

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

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

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

describeIndexSql()source абстрактный общедоступный

describeIndexSql( string $tableName , array $config )

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

Параметры

строка $tableName

Имя таблицы, информация о которой требуется.

массив $config

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

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

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

describeOptionsSql()source общедоступный

describeOptionsSql( string $tableName , array $config )

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

Параметры

строка $tableName

Имя таблицы.

массив $config

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

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

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

dropConstraintSql()source абстрактный общедоступный

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

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

Параметры

Cake\Database\Schema\Table $table

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

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

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

dropTableSql()source общедоступный

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

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

Параметры

Cake\Database\Schema\Table $table

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

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

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

indexSql()source абстрактный общедоступный

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

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

Параметры

Cake\Database\Schema\Table $table

Объект таблицы, содержащий столбец.

строка $name

Имя столбца.

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

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

listTablesSql()source абстрактный общедоступный

listTablesSql( array $config )

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

Параметры

массив $config

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

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

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

truncateTableSql()source абстрактный общедоступный

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

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

Параметры

Cake\Database\Schema\Table $table

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

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

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