Класс yii\db\TableSchema

Все классы | Свойства | Методы

Наследование	yii\db\TableSchema » yii\base\Object
Реализует	yii\base\Configurable
Подклассы	yii\db\mssql\TableSchema
Доступна с версии	2.0
Исходный код	https://github.com/yiisoft/yii2/blob/master/framework/db/TableSchema.php

TableSchema представляет метаданные базы данных таблицы.

Открытые свойства

Свойство	Тип	Описание	Определено
$columnNames	массив	Список имен столбцов	yii\db\TableSchema
$columns	yii\db\ColumnSchema[]	Метаданные столбцов этой таблицы.	yii\db\TableSchema
$foreignKeys	массив	Внешние ключи этой таблицы.	yii\db\TableSchema
$fullName	строка	Полное имя этой таблицы, включающее префикс имени схемы, если таковой имеется.	yii\db\TableSchema
$name	строка	Имя этой таблицы.	yii\db\TableSchema
$primaryKey	строка[]	Первичные ключи этой таблицы.	yii\db\TableSchema
$schemaName	строка	Имя схемы, к которой принадлежит эта таблица.	yii\db\TableSchema
$sequenceName	строка	Имя последовательности для первичного ключа.	yii\db\TableSchema

Открытые методы

Метод	Описание	Определено в
__call()	Вызывает именованный метод, который не является методом класса.	yii\base\Object
__construct()	Конструктор.	yii\base\Object
__get()	Возвращает значение свойства объекта.	yii\base\Object
__isset()	Проверяет, установлено ли свойство, т.е. определено и не равно null.	yii\base\Object
__set()	Устанавливает значение свойства объекта.	yii\base\Object
__unset()	Устанавливает свойство объекта в null.	yii\base\Object
canGetProperty()	Возвращает значение, указывающее, можно ли считать свойство.	yii\base\Object
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Object
className()	Возвращает полное имя этого класса.	yii\base\Object
fixPrimaryKey()	Вручную задаёт первичный ключ для этой таблицы.	yii\db\TableSchema
getColumn()	Получает метаданные указанного столбца.	yii\db\TableSchema
getColumnNames()	Возвращает имена всех столбцов в этой таблице.	yii\db\TableSchema
hasMethod()	Возвращает значение, указывающее, определён ли метод.	yii\base\Object
hasProperty()	Возвращает значение, указывающее, определено ли свойство.	yii\base\Object
init()	Инициализирует объект.	yii\base\Object

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

$columnNames общедоступное только для чтения свойство

Список имён столбцов

public array getColumnNames ( )

$columns общедоступное свойство

Метаданные столбцов этой таблицы. Каждый элемент массива — объект yii\db\ColumnSchema, индексированный по именам столбцов.

public yii\db\ColumnSchema[] $columns = []

$foreignKeys общедоступное свойство

Внешние ключи этой таблицы. Каждый элемент массива имеет следующий формат:

[
 'ForeignTableName',
 'fk1' => 'pk1',  // pk1 is in foreign table
 'fk2' => 'pk2',  // if composite foreign key
]

public array $foreignKeys = []

$fullName общедоступное свойство

Полное имя этой таблицы, включающее префикс имени схемы, если таковой имеется. Обратите внимание, что если имя схемы совпадает с именем схемы по умолчанию, имя схемы не будет включено.

public string $fullName = null

$name общедоступное свойство

Имя этой таблицы. Имя схемы не включено. Используйте $fullName, чтобы получить имя со схемой.

public string $name = null

$primaryKey общедоступное свойство

Первичные ключи этой таблицы.

public string[] $primaryKey = []

$schemaName общедоступное свойство

Имя схемы, к которой принадлежит эта таблица.

public string $schemaName = null

$sequenceName общедоступное свойство

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

public string $sequenceName = null

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

fixPrimaryKey() public method

Вручную задаёт первичный ключ для этой таблицы.

public void fixPrimaryKey ( $keys )
$keys	string\|array	Первичный ключ (может быть составным)
throws	yii\base\InvalidParamException	если указанный ключ не найден в таблице.

getColumn() public method

Получает метаданные указанного столбца.

Этот метод удобно использовать для получения метаданных столбца, даже если он отсутствует.

public yii\db\ColumnSchema getColumn ( $name )
$name	string	Имя столбца
return	yii\db\ColumnSchema	Метаданные указанного столбца. Null, если столбец не найден.

getColumnNames() public method

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

public array getColumnNames ( )
return	array	Список имён столбцов

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-db-tableschema.html