Интерфейс SchemaInterface

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

Пространство имён: Cake\Datasource

Краткое описание методов

addColumn() public

Добавить столбец в таблицу.
baseColumnType() public

Возвращает имя базового типа для заданного столбца. Представляет собой тип базы данных, на котором основан более сложный класс.
columns() public

Получить имена столбцов в таблице.
defaultValues() public

Получить хэш столбцов и их значений по умолчанию.
getColumn() public

Получить данные столбца в таблице.
getColumnType() public

Возвращает тип столбца или null, если столбец не существует.
getOptions() public

Получить параметры таблицы.
hasColumn() public

Возвращает true, если столбец существует в схеме.
isNullable() public

Проверить, является ли поле допустимым для null.
name() public

Получить имя таблицы.
removeColumn() public

Удалить столбец из схемы таблицы.
setColumnType() public

Установить тип столбца.
setOptions() public

Установить параметры таблицы.
typeMap() public

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

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

addColumn() public

addColumn(string $name, string|array $attrs): $this

Добавить столбец в таблицу.

Атрибуты

Столбцы могут иметь несколько атрибутов:

type Тип столбца. Должен быть одним из абстрактных типов CakePHP.
length Длина столбца.
precision Количество десятичных знаков для хранения типов float и decimal.
default Значение по умолчанию для столбца.
null Возможность хранения null-значений в столбце.
fixed Является ли столбец столбцом фиксированной длины. Присутствует/действителен только для строковых столбцов.
unsigned Является ли столбец беззнаковым столбцом. Присутствует/действителен для столбцов integer, decimal, float.

В дополнение к вышеперечисленным ключам, следующие ключи реализованы в некоторых диалектах баз данных, но не во всех:

comment Комментарий к столбцу.

Параметры

string $name: Имя столбца
string|array $attrs: Атрибуты столбца или имя типа.

Возвращает

$this

baseColumnType() public

baseColumnType(string $column): string|null

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

Параметры

string $column: Имя столбца для получения базового типа

Возвращает

string|null

columns() public

columns(): string[]

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

Возвращает

string[]

defaultValues() public

defaultValues(): array

Получить хэш столбцов и их значений по умолчанию.

Возвращает

array

getColumn() public

getColumn(string $name): array|null

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

Параметры

string $name: Имя столбца.

Возвращает

array|null

getColumnType() public

getColumnType(string $name): string|null

Возвращает тип столбца или null, если столбец не существует.

Параметры

string $name: Столбец, для получения типа.

Возвращает

string|null

getOptions() public

getOptions(): array

Получить параметры таблицы.

Параметры таблицы позволяют устанавливать параметры уровня таблицы, специфичные для платформы. Например, тип движка в MySQL.

Возвращает

array

hasColumn() public

hasColumn(string $name): bool

Возвращает true, если столбец существует в схеме.

Параметры

string $name: Имя столбца.

Возвращает

bool

isNullable() public

isNullable(string $name): bool

Проверить, является ли поле допустимым для null.

Отсутствующие столбцы являются допустимыми для null.

Параметры

string $name: Столбец, для получения типа.

Возвращает

bool

name() public

name(): string

Получить имя таблицы.

Возвращает

string

removeColumn() public

removeColumn(string $name): $this

Удалить столбец из схемы таблицы.

Если столбец не определен в таблице, ошибка не будет поднята.

Параметры

string $name: Имя столбца

Возвращает

$this

setColumnType() public

setColumnType(string $name, string $type): $this

Установить тип столбца.

Параметры

string $name: Столбец, для установки типа.
string $type: Тип, для установки столбца.

Возвращает

$this

setOptions() public

setOptions(array $options): $this

Установить параметры таблицы.

Параметры

array $options: Параметры для установки, или null для чтения параметров.

Возвращает

$this

typeMap() public

typeMap(): array

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

Возвращает

array

© 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/4.2/interface-Cake.Datasource.SchemaInterface.html