Интерфейс TableSchemaInterface

addConstraint()source public

addConstraint( string $name , array $attrs )

Добавить ограничение.

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

Атрибуты

• type Тип добавляемого ограничения.
• columns Столбцы в индексе.
• references Таблица, столбец, к которому относится внешний ключ.
• update Поведение при обновлении. Доступны варианты: 'restrict', 'setNull', 'cascade', 'noAction'.
• delete Поведение при удалении. Доступны варианты: 'restrict', 'setNull', 'cascade', 'noAction'.

По умолчанию для 'update' и 'delete' используется 'cascade'.

Параметры

string $name

Имя ограничения.

array $attrs

Атрибуты для ограничения.

Возвращает

$this

addIndex()source public

addIndex( string $name , array $attrs )

Добавить индекс.

Используется для добавления индексов и полных текстовых индексов в платформах, которые их поддерживают.

Атрибуты

• type Тип добавляемого индекса.
• columns Столбцы в индексе.

Параметры

string $name

Имя индекса.

array $attrs

Атрибуты для индекса.

Возвращает

$this

constraints()source public

constraints( )

Получить имена всех ограничений в таблице.

Возвращает

массив

dropConstraint()source public

dropConstraint( string $name )

Удалить ограничение.

Параметры

string $name

Имя ограничения для удаления

Возвращает

$this

getConstraint()source public

getConstraint( string $name )

Прочитать информацию об ограничении по имени.

Параметры

string $name

Имя ограничения.

Возвращает

массив|null
Массив данных ограничения или null

getIndex()source public

getIndex( string $name )

Прочитать информацию об индексе по имени.

Параметры

string $name

Имя индекса.

Возвращает

массив|null
Массив данных индекса или null

hasAutoincrement()source public

hasAutoincrement( )

Проверить, определён ли столбец autoIncrement для таблицы.

Возвращает

булево

indexes()source public

indexes( )

Получить имена всех индексов в таблице.

Возвращает

array

isTemporary()source public

isTemporary( )

Получить, является ли таблица временной в базе данных.

Возвращает

boolean
Текущее значение временной таблицы.

primaryKey()source public

primaryKey( )

Получить столбец(ы), используемый для первичного ключа.

Возвращает

array

Имя(на) столбца для первичного ключа. Если в таблице нет первичного ключа, будет возвращен пустой список.

setTemporary()source public

setTemporary( boolean $temporary )

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

Параметры

boolean $temporary

Является ли таблица временной.

Возвращает

$this