Класс TableSchema

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

Может быть заполнен с помощью API рефлексии или путем поэтапного построения экземпляра с помощью методов.

После создания экземпляры TableSchema могут быть добавлены в объекты Schema\Collection. Их также можно преобразовать в SQL с помощью методов createSql(), dropSql() и truncateSql().

Cake\Database\Schema\TableSchema реализует Cake\Database\Schema\TableSchemaInterface, Cake\Database\Schema\SqlGeneratorInterface

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

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

string

ACTION_CASCADE

'cascade'
string

ACTION_NO_ACTION

'noAction'
string

ACTION_RESTRICT

'restrict'
string

ACTION_SET_DEFAULT

'setDefault'
string

ACTION_SET_NULL

'setNull'
string

CONSTRAINT_FOREIGN

'foreign'
string

CONSTRAINT_PRIMARY

'primary'
string

CONSTRAINT_UNIQUE

'unique'
string

INDEX_FULLTEXT

'fulltext'
string

INDEX_INDEX

'index'
integer

LENGTH_LONG

4294967295
integer

LENGTH_MEDIUM

16777215
integer

LENGTH_TINY

255

Унаследованные константы

TYPE_BIGINTEGER, TYPE_BINARY, TYPE_BINARY_UUID, TYPE_BOOLEAN, TYPE_DATE, TYPE_DATETIME, TYPE_DECIMAL, TYPE_FLOAT, TYPE_INTEGER, TYPE_JSON, TYPE_SMALLINTEGER, TYPE_STRING, TYPE_TEXT, TYPE_TIME, TYPE_TIMESTAMP, TYPE_TINYINTEGER, TYPE_UUID

Резюме свойств

$_columnExtras protected static

array
Дополнительные свойства, специфичные для типа.
$_columnKeys protected static

array

Допустимые ключи, которые могут быть использованы в определении столбца.
$_columns protected

array
Столбцы в таблице.
$_constraints protected

array
Ограничения в таблице.
$_indexKeys protected static

array

Допустимые ключи, которые могут быть использованы в определении индекса.
$_indexes protected

array
Индексы в таблице.
$_options protected

array
Параметры для таблицы.
$_table protected

string
Имя таблицы
$_temporary protected

boolean
Является ли таблица временной
$_typeMap protected

array
Карта со столбцами и типами
$_validConstraintTypes protected static

array
Названия допустимых типов ограничений.
$_validForeignKeyActions protected static

array
Названия допустимых действий для внешних ключей.
$_validIndexTypes protected static

array
Названия допустимых типов индексов.
$columnLengths public static

array
Допустимая длина столбца, которая может быть использована со столбцами типа text

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

__construct() public
Конструктор.
__debugInfo() public
Возвращает массив схемы таблицы.
_checkForeignKey() protected
Вспомогательный метод для проверки/валидации внешних ключей.
addColumn() public
Добавление столбца в таблицу.
addConstraint() public
Добавление ограничения.
addConstraintSql() public
Генерирует SQL-запросы для добавления ограничений к таблице.
addIndex() public
Добавление индекса.
baseColumnType() public

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

Устанавливает тип столбца или возвращает его текущий тип, если он не передан.
columns() public
Получение имен столбцов в таблице.
constraint() public deprecated
Чтение информации об ограничении на основе имени.
constraints() public
Получение имён всех ограничений в таблице.
createSql() public
Генерирует SQL для создания таблицы.
defaultValues() public
Получение хэша столбцов и их значений по умолчанию.
dropConstraint() public
Удаление ограничения.
dropConstraintSql() public
Генерирует SQL-запросы для удаления ограничений из таблицы.
dropSql() public
Генерирует SQL для удаления таблицы.
getColumn() public
Получение данных столбца в таблице.
getColumnType() public
Возвращает тип столбца или null, если столбец не существует.
getConstraint() public
Чтение информации об ограничении на основе имени.
getIndex() public
Чтение информации об индексе на основе имени.
getOptions() public
Получение параметров таблицы.
hasAutoincrement() public
Проверка наличия столбца autoIncrement в таблице.
hasColumn() public
Возвращает true, если столбец существует в схеме.
index() public deprecated
Чтение информации об индексе на основе имени.
indexes() public
Получение имён всех индексов в таблице.
isNullable() public
Проверка, является ли поле nullable.
isTemporary() public
Получение информации о том, является ли таблица временной в базе данных.
name() public
Получение имени таблицы.
options() public deprecated
Получение/установка параметров таблицы.
primaryKey() public
Получение столбца(ов), используемого для первичного ключа.
removeColumn() public
Удаление столбца из схемы таблицы.
setColumnType() public
Установка типа столбца.
setOptions() public
Установка параметров таблицы.
setTemporary() public
Установка того, является ли таблица временной в базе данных.
temporary() public deprecated
Получение/Установка того, является ли таблица временной в базе данных.
truncateSql() public
Генерирует SQL-запросы для усечения таблицы.
typeMap() public

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

Детали метода

__construct()source public

__construct( string $table , array $columns = [] )

Конструктор.

Параметры

строка $table: Имя таблицы.
массив $columns optional []: Список столбцов для схемы.

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

_checkForeignKey()source protected

_checkForeignKey( array $attrs )

Вспомогательный метод для проверки/валидации внешних ключей.

Параметры

массив $attrs: Атрибуты для установки.

Возвращает

массив

Исключения

Cake\Database\Exception
При некорректном определении внешнего ключа.

addColumn()source public

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

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

Параметры

строка $name: Имя столбца
массив|строка $attrs: Атрибуты для столбца.

Возвращает

$this

Реализация

Cake\Datasource\SchemaInterface::addColumn()

addConstraint()source public

addConstraint( string $name , array $attrs )

Добавление ограничения.

Параметры

строка $name: Имя ограничения.
массив $attrs: Атрибуты для ограничения.

Возвращает

$this

Исключения

Cake\Database\Exception

Реализация

Cake\Database\Schema\TableSchemaInterface::addConstraint()

addConstraintSql()source public

addConstraintSql( Cake\Database\Connection $connection )

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

Параметры

Cake\Database\Connection $connection: Соединение для генерации SQL.

Возвращает

массив
SQL для добавления ограничений.

Реализация

Cake\Database\Schema\SqlGeneratorInterface::addConstraintSql()

addIndex()source public

addIndex( string $name , array $attrs )

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

Параметры

строка $name: Имя индекса.
массив $attrs: Атрибуты индекса.

Возвращает

$this

Исключения

Cake\Database\Exception

Реализация

Cake\Database\Schema\TableSchemaInterface::addIndex()

baseColumnType()source public

baseColumnType( string $column )

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

Параметры

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

Возвращает

строка|null
Имя базового типа

Реализация

Cake\Datasource\SchemaInterface::baseColumnType()

column()source public deprecated

column( string $name )

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

Устарело

3.5.0 Используйте getColumn() вместо этого.

Параметры

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

Возвращает

массив|null
Данные столбца или null.

columnType()source public deprecated

columnType( string $name , string|null $type = null )

Устанавливает тип столбца или возвращает его текущий тип, если не задан.

Устарело

3.5.0 Используйте setColumnType()/getColumnType() вместо этого.

Параметры

строка $name: Столбец для получения типа.
строка|null $type необязательно null: Тип для установки столбца.

Возвращает

строка|null
Тип столбца или null.

columns()source public

columns( )

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

Возвращает

массив строк

Реализация

Cake\Datasource\SchemaInterface::columns()

constraint()source public deprecated

constraint( string $name )

Получить информацию о ограничении на основе имени.

Устарело

3.5.0 Используйте getConstraint() вместо этого.

Параметры

строка $name: Имя ограничения.

Возвращает

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

constraints()source public

constraints( )

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

Возвращает

массив строк

Реализация

Cake\Database\Schema\TableSchemaInterface::constraints()

createSql()source public

createSql( Cake\Database\Connection $connection )

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

Параметры

Cake\Database\Connection $connection: Соединение для генерации SQL.

Возвращает

массив

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

Реализация

Cake\Database\Schema\SqlGeneratorInterface::createSql()

defaultValues()source public

defaultValues( )

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

Возвращает

массив

Реализация

Cake\Datasource\SchemaInterface::defaultValues()

dropConstraint()source public

dropConstraint( string $name )

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

Параметры

строка $name: Имя ограничения для удаления

Возвращает

$this

Реализация

Cake\Database\Schema\TableSchemaInterface::dropConstraint()

dropConstraintSql()source public

dropConstraintSql( Cake\Database\Connection $connection )

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

Параметры

Cake\Database\Connection $connection: Соединение для генерации SQL.

Возвращает

массив
SQL для удаления таблицы.

Реализация

Cake\Database\Schema\SqlGeneratorInterface::dropConstraintSql()

dropSql()source public

dropSql( Cake\Database\Connection $connection )

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

Параметры

Cake\Database\Connection $connection: Соединение для генерации SQL.

Возвращает

массив
SQL для удаления таблицы.

Реализация

Cake\Database\Schema\SqlGeneratorInterface::dropSql()

getColumn()source public

getColumn( string $name )

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

Параметры

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

Возвращает

массив|null
Данные столбца или null.

Реализация

Cake\Datasource\SchemaInterface::getColumn()

getColumnType()source public

getColumnType( string $name )

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

Параметры

строка $name: Столбец для получения типа.

Возвращает

строка|null

Реализация

Cake\Datasource\SchemaInterface::getColumnType()

getConstraint()source public

getConstraint( string $name )

Получить информацию о ограничении на основе имени.

Параметры

строка $name: Имя ограничения.

Возвращает

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

Реализация

Cake\Database\Schema\TableSchemaInterface::getConstraint()

getIndex()source public

getIndex( string $name )

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

Параметры

строка $name: Имя индекса.

Возвращает

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

Реализация

Cake\Database\Schema\TableSchemaInterface::getIndex()

getOptions()source public

getOptions( )

Получает опции для таблицы.

Возвращает

массив
Массив опций.

Реализация

Cake\Datasource\SchemaInterface::getOptions()

hasAutoincrement()source public

hasAutoincrement( )

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

Возвращает

логическое значение

Реализация

Cake\Database\Schema\TableSchemaInterface::hasAutoincrement()

hasColumn()source public

hasColumn( string $name )

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

Параметры

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

Возвращает

логическое значение

Реализация

Cake\Datasource\SchemaInterface::hasColumn()

END_OF_DOCUMENT_MARKER

index()source public deprecated

index( string $name )

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

Устаревший

3.5.0 Используйте метод getIndex() вместо этого.

Параметры

строка $name: Имя индекса.

Возвращает

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

indexes()source public

indexes( )

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

Возвращает

string[]

Реализация

Cake\Database\Schema\TableSchemaInterface::indexes()

isNullable()source public

isNullable( string $name )

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

Параметры

строка $name: Имя столбца, для которого нужно получить тип.

Возвращает

boolean
Является ли поле nullable.

Реализация

Cake\Datasource\SchemaInterface::isNullable()

isTemporary()source public

isTemporary( )

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

Возвращает

boolean
Текущее значение временности.

Реализация

Cake\Database\Schema\TableSchemaInterface::isTemporary()

name()source public

name( )

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

Возвращает

string

Реализация

Cake\Datasource\SchemaInterface::name()

options()source public deprecated

options( array|null $options = null )

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

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

Устаревший

3.4.0 Используйте setOptions()/getOptions() вместо этого.

Параметры

массив|null $options необязательный null: Параметры для установки или null для чтения параметров.

Возвращает

$this|массив Либо экземпляр TableSchema, либо массив параметров при чтении.

primaryKey()source public

primaryKey( )

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

Возвращает

массив

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

Реализация

Cake\Database\Schema\TableSchemaInterface::primaryKey()

removeColumn()source public

removeColumn( string $name )

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

Параметры

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

Возвращает

$this

Реализация

Cake\Datasource\SchemaInterface::removeColumn()

setColumnType()source public

setColumnType( string $name , string $type )

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

Параметры

строка $name: Столбец, для которого нужно установить тип.
строка $type: Тип, на который нужно установить столбец.

Возвращает

$this

Реализация

Cake\Datasource\SchemaInterface::setColumnType()

setOptions()source public

setOptions( array $options )

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

Параметры

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

Возвращает

$this

Реализация

Cake\Datasource\SchemaInterface::setOptions()

setTemporary()source public

setTemporary( boolean $temporary )

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

Параметры

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

Возвращает

$this

Реализация

Cake\Database\Schema\TableSchemaInterface::setTemporary()

temporary()source public deprecated

temporary( boolean|null $temporary = null )

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

Устаревший

3.4.0 Используйте setTemporary()/isTemporary() вместо этого.

Параметры

boolean|null $temporary необязательный null: Является ли таблица временной

Возвращает

$this|bool Экземпляр TableSchema, текущее значение временности

truncateSql()source public

truncateSql( Cake\Database\Connection $connection )

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

Параметры

Cake\Database\Connection $connection: Подключение для генерации SQL.

Возвращает

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

Реализация

Cake\Database\Schema\SqlGeneratorInterface::truncateSql()

typeMap()source public

typeMap( )

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

Возвращает

массив

Реализация

Cake\Datasource\SchemaInterface::typeMap()

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

$_columnExtrassource

protected static массив

Дополнительные свойства, специфичные для типа.

[
    'string' => [
        'fixed' => null,
        'collate' => null,
    ],
    'text' => [
        'collate' => null,
    ],
    'tinyinteger' => [
        'unsigned' => null,
    ],
    'smallinteger' => [
        'unsigned' => null,
    ],
    'integer' => [
        'unsigned' => null,
        'autoIncrement' => null,
    ],
    'biginteger' => [
        'unsigned' => null,
        'autoIncrement' => null,
    ],
    'decimal' => [
        'unsigned' => null,
    ],
    'float' => [
        'unsigned' => null,
    ],
]

$_columnKeyssource

protected static массив

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

[
    'type' => null,
    'baseType' => null,
    'length' => null,
    'precision' => null,
    'null' => null,
    'default' => null,
    'comment' => null,
]

$_columnssource

protected массив

Столбцы в таблице.

[]

$_constraintssource

protected массив

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

[]

$_indexKeyssource

protected static массив

Допустимые ключи, которые можно использовать в определении индекса.

[
    'type' => null,
    'columns' => [],
    'length' => [],
    'references' => [],
    'update' => 'restrict',
    'delete' => 'restrict',
]

$_indexessource

protected массив

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

[]

$_optionssource

protected массив

Параметры таблицы.

[]

END_OF_DOCUMENT_MARKER

$_tablesource

protected string

Имя таблицы

$_temporarysource

protected boolean

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

false

$_typeMapsource

protected array

Отображение столбцов к типам

[]

$_validConstraintTypessource

protected static array

Имена допустимых типов ограничений.

[
    self::CONSTRAINT_PRIMARY,
    self::CONSTRAINT_UNIQUE,
    self::CONSTRAINT_FOREIGN,
]

$_validForeignKeyActionssource

protected static array

Имена допустимых действий для внешних ключей.

[
    self::ACTION_CASCADE,
    self::ACTION_SET_NULL,
    self::ACTION_SET_DEFAULT,
    self::ACTION_NO_ACTION,
    self::ACTION_RESTRICT,
]

$_validIndexTypessource

protected static array

Имена допустимых типов индексов.

[
    self::INDEX_INDEX,
    self::INDEX_FULLTEXT,
]

$columnLengthssource

public static array

Допустимые длины столбцов, которые могут использоваться со столбцами типа text

[
    'tiny' => self::LENGTH_TINY,
    'medium' => self::LENGTH_MEDIUM,
    'long' => self::LENGTH_LONG
]

© 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.7/class-Cake.Database.Schema.TableSchema.html