Интерфейс SchemaInterface

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

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

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

addColumn() public

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

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

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

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

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

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

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

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

Проверить, является ли поле nullable.
name() public

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

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

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

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

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

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

addColumn() public

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

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

Атрибуты

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

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

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

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

Параметры

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

Возвращает

$this

baseColumnType() public

baseColumnType(string $column): string|null

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

Параметры

string $column: Имя столбца, для которого нужно получить базовый тип.

Возвращает

string|null

columns() public

columns(): array<string>

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

Возвращает

array<string>

defaultValues() public

defaultValues(): array<string, mixed>

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

Возвращает

array<string, mixed>

getColumn() public

getColumn(string $name): array<string, mixed>|null

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

Параметры

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

Возвращает

array<string, mixed>|null

getColumnType() public

getColumnType(string $name): string|null

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

Параметры

string $name: Столбец, тип которого нужно получить.

Возвращает

string|null

getOptions() public

getOptions(): array<string, mixed>

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

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

Возвращает

array<string, mixed>

hasColumn() public

hasColumn(string $name): bool

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

Параметры

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

Возвращает

bool

isNullable() public

isNullable(string $name): bool

Проверить, является ли поле nullable.

Отсутствующие столбцы nullable.

Параметры

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<string, mixed> $options): $this

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

Параметры

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

Возвращает

$this

typeMap() public

typeMap(): array<string, string>

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

Возвращает

array<string, string>

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