Интерфейс TableSchemaInterface

Интерфейс, используемый объектами схемы таблицы базы данных.

Устарело 3.5.0: Используйте Cake\Database\TableSchemaAwareInterface вместо этого.

Cake\Database\Schema\TableSchemaInterface реализует Cake\Datasource\SchemaInterface

Прямые реализаторы

Cake\Database\Schema\TableSchema

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

Резюме констант

string

TYPE_BIGINTEGER

'biginteger'
string

TYPE_BINARY

'binary'
string

TYPE_BINARY_UUID

'binaryuuid'
string

TYPE_BOOLEAN

'boolean'
string

TYPE_DATE

'date'
string

TYPE_DATETIME

'datetime'
string

TYPE_DECIMAL

'decimal'
string

TYPE_FLOAT

'float'
string

TYPE_INTEGER

'integer'
string

TYPE_JSON

'json'
string

TYPE_SMALLINTEGER

'smallinteger'
string

TYPE_STRING

'string'
string

TYPE_TEXT

'text'
string

TYPE_TIME

'time'
string

TYPE_TIMESTAMP

'timestamp'
string

TYPE_TINYINTEGER

'tinyinteger'
string

TYPE_UUID

'uuid'

Резюме методов

addConstraint() public
Добавить ограничение.
addIndex() public
Добавить индекс.
constraints() public
Получить имена всех ограничений в таблице.
dropConstraint() public
Удалить ограничение.
getConstraint() public
Прочитать информацию об ограничении по имени.
getIndex() public
Прочитать информацию об индексе по имени.
hasAutoincrement() public
Проверить, определён ли столбец autoIncrement в таблице.
indexes() public
Получить имена всех индексов в таблице.
isTemporary() public
Получить, является ли таблица временной в базе данных.
primaryKey() public
Получить столбец(ы), используемый для первичного ключа.
setTemporary() public
Устанавливает, является ли таблица временной в базе данных.

Подробное описание метода

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

END_OF_DOCUMENT_MARKER

hasAutoincrement()source public

hasAutoincrement( )

Проверка, определён ли в таблице столбец автоинкремента.

Возвращает

boolean

indexes()source public

indexes( )

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

Возвращает

массив

isTemporary()source public

isTemporary( )

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

Возвращает

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

primaryKey()source public

primaryKey( )

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

Возвращает

массив

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

setTemporary()source public

setTemporary( boolean $temporary )

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

Параметры

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

Возвращает

$this

© 2005–present 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.6/class-Cake.Database.Schema.TableSchemaInterface.html