Класс yii\db\mysql\ColumnSchemaBuilder
| Наследование | yii\db\mysql\ColumnSchemaBuilder » yii\db\ColumnSchemaBuilder » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0.8 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/db/mysql/ColumnSchemaBuilder.php |
ColumnSchemaBuilder — это генератор схем для баз данных MySQL.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $categoryMap | массив | Сопоставление абстрактных типов столбцов (ключи) с категориями типов (значения). | yii\db\ColumnSchemaBuilder |
| $comment | строка | Значение комментария столбца. | yii\db\ColumnSchemaBuilder |
| $db | yii\db\Connection | Текущее подключение к базе данных. | yii\db\ColumnSchemaBuilder |
Защищенные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $after | строка | Столбец, после которого будет добавлен данный столбец. | yii\db\ColumnSchemaBuilder |
| $append | смешанный тип | Строка SQL, которая будет добавлена к определению схемы столбца. | yii\db\ColumnSchemaBuilder |
| $check | строка | Ограничение CHECK для столбца. | yii\db\ColumnSchemaBuilder |
| $default | смешанный тип | Значение по умолчанию столбца. | yii\db\ColumnSchemaBuilder |
| $isFirst | логический тип | Указывает, должен ли данный столбец быть вставлен в начало таблицы. | yii\db\ColumnSchemaBuilder |
| $isNotNull | логический тип|null | Указывает, является ли столбец непустым. | yii\db\ColumnSchemaBuilder |
| $isUnique | логический тип | Указывает, должны ли значения столбца быть уникальными. | yii\db\ColumnSchemaBuilder |
| $isUnsigned | логический тип | Указывает, должны ли значения столбца быть без знака. | yii\db\ColumnSchemaBuilder |
| $length | целое число|строка|массив | Размер столбца или определение точности. | yii\db\ColumnSchemaBuilder |
| $type | строка | Определение типа столбца, например INTEGER, VARCHAR, DATETIME и т.д. | yii\db\ColumnSchemaBuilder |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __construct() | Создает экземпляр генератора схемы столбца, задавая тип и точность значения. | yii\db\ColumnSchemaBuilder |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __toString() | Строит полную строку схемы столбца | yii\db\mysql\ColumnSchemaBuilder |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| after() | Добавляет ограничение AFTER к столбцу. | yii\db\ColumnSchemaBuilder |
| append() | Указывает дополнительную SQL-строку, которая будет добавлена к определению столбца. | yii\db\ColumnSchemaBuilder |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| check() | Устанавливает ограничение CHECK для столбца. | yii\db\ColumnSchemaBuilder |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| comment() | Указывает комментарий для столбца. | yii\db\ColumnSchemaBuilder |
| defaultExpression() | Указывает SQL-выражение по умолчанию для столбца. | yii\db\ColumnSchemaBuilder |
| defaultValue() | Указывает значение по умолчанию для столбца. | yii\db\ColumnSchemaBuilder |
| first() | Добавляет ограничение FIRST к столбцу. | yii\db\ColumnSchemaBuilder |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| notNull() | Добавляет ограничение NOT NULL к столбцу. | yii\db\ColumnSchemaBuilder |
| null() | Добавляет ограничение NULL к столбцу. | yii\db\ColumnSchemaBuilder |
| unique() | Добавляет ограничение UNIQUE к столбцу. | yii\db\ColumnSchemaBuilder |
| unsigned() | Помечает столбец как без знака. | yii\db\ColumnSchemaBuilder |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| buildAfterString() | Строит ограничение AFTER для столбца. По умолчанию не поддерживается. | yii\db\mysql\ColumnSchemaBuilder |
| buildAppendString() | Строит пользовательскую строку, добавляемую к определению столбца. | yii\db\ColumnSchemaBuilder |
| buildCheckString() | Строит ограничение CHECK для столбца. | yii\db\ColumnSchemaBuilder |
| buildCommentString() | Строит спецификацию комментария для столбца. | yii\db\mysql\ColumnSchemaBuilder |
| buildCompleteString() | Возвращает полное определение столбца из входного формата | yii\db\ColumnSchemaBuilder |
| buildDefaultString() | Строит спецификацию значения по умолчанию для столбца. | yii\db\ColumnSchemaBuilder |
| buildFirstString() | Строит первое ограничение для столбца. По умолчанию не поддерживается. | yii\db\mysql\ColumnSchemaBuilder |
| buildLengthString() | Строит часть длины/точности столбца. | yii\db\ColumnSchemaBuilder |
| buildNotNullString() | Строит ограничение NOT NULL для столбца. | yii\db\ColumnSchemaBuilder |
| buildUniqueString() | Строит ограничение UNIQUE для столбца. | yii\db\ColumnSchemaBuilder |
| buildUnsignedString() | Строит строку UNSIGNED для столбца. По умолчанию не поддерживается. | yii\db\mysql\ColumnSchemaBuilder |
| getTypeCategory() | Возвращает категорию типа столбца. | yii\db\ColumnSchemaBuilder |
Константы
| Константа | Значение | Описание | Определено в |
|---|---|---|---|
| CATEGORY_NUMERIC | 'numeric' | yii\db\ColumnSchemaBuilder | |
| CATEGORY_OTHER | 'other' | yii\db\ColumnSchemaBuilder | |
| CATEGORY_PK | 'pk' | yii\db\ColumnSchemaBuilder | |
| CATEGORY_STRING | 'string' | yii\db\ColumnSchemaBuilder | |
| CATEGORY_TIME | 'time' | yii\db\ColumnSchemaBuilder |
Подробное описание методов
__toString() публичный метод
Строит полную строку для схемы столбца
| public string __toString ( ) |
|---|
buildAfterString() защищённый метод
Строит ограничение AFTER для столбца. По умолчанию не поддерживается.
| protected string buildAfterString ( ) | ||
|---|---|---|
| возвращает | string |
Строка, содержащая ограничение AFTER. |
buildCommentString() защищённый метод
Строит спецификацию комментария для столбца.
| protected string buildCommentString ( ) | ||
|---|---|---|
| возвращает | string |
Строка, содержащая ключевое слово COMMENT и сам комментарий |
buildFirstString() защищённый метод
Строит первое ограничение для столбца. По умолчанию не поддерживается.
| protected string buildFirstString ( ) | ||
|---|---|---|
| возвращает | string |
Строка, содержащая ограничение FIRST. |
buildUnsignedString() защищённый метод
Строит строку UNSIGNED для столбца. По умолчанию не поддерживается.
| protected string buildUnsignedString ( ) | ||
|---|---|---|
| возвращает | string |
Строка, содержащая ключевое слово UNSIGNED. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-db-mysql-columnschemabuilder.html
