Класс yii\db\mssql\TableSchema
| Наследование | yii\db\mssql\TableSchema » yii\db\TableSchema » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/db/mssql/TableSchema.php |
TableSchema представляет метаданные таблицы базы данных.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $catalogName | строка | Имя каталога (базы данных), к которому принадлежит эта таблица. | yii\db\mssql\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 |
Подробное описание свойств
$catalogName публичное свойство
Имя каталога (базы данных), к которому принадлежит эта таблица. По умолчанию null, что означает, что нет каталога (или текущая база данных).
public string $catalogName = null
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-db-mssql-tableschema.html
