Класс yii\db\cubrid\ColumnSchemaBuilder
| Наследование | yii\db\cubrid\ColumnSchemaBuilder » yii\db\ColumnSchemaBuilder » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0.8 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/db/cubrid/ColumnSchemaBuilder.php |
ColumnSchemaBuilder — генератор схем для баз данных Cubrid.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $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\cubrid\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\cubrid\ColumnSchemaBuilder |
| buildAppendString() | Создаёт пользовательскую строку, добавляемую к определению столбца. | yii\db\ColumnSchemaBuilder |
| buildCheckString() | Создаёт ограничение CHECK для столбца. | yii\db\ColumnSchemaBuilder |
| buildCommentString() | Создаёт спецификацию комментария для столбца. | yii\db\cubrid\ColumnSchemaBuilder |
| buildCompleteString() | Возвращает полное определение столбца из входного формата | yii\db\ColumnSchemaBuilder |
| buildDefaultString() | Создаёт спецификацию значения по умолчанию для столбца. | yii\db\ColumnSchemaBuilder |
| buildFirstString() | Создаёт первое ограничение для столбца. По умолчанию не поддерживается. | yii\db\cubrid\ColumnSchemaBuilder |
| buildLengthString() | Создаёт часть длины/точности столбца. | yii\db\ColumnSchemaBuilder |
| buildNotNullString() | Создаёт ограничение NOT NULL для столбца. | yii\db\ColumnSchemaBuilder |
| buildUniqueString() | Создаёт ограничение UNIQUE для столбца. | yii\db\ColumnSchemaBuilder |
| buildUnsignedString() | Создаёт строку UNSIGNED для столбца. По умолчанию не поддерживается. | yii\db\cubrid\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 метод
Создаёт полную строку для схемы столбца
| public string __toString ( ) |
|---|
buildAfterString() protected метод
Создаёт ограничение AFTER для столбца. По умолчанию не поддерживается.
| protected string buildAfterString ( ) | ||
|---|---|---|
| return | string |
Строка, содержащая ограничение AFTER. |
buildCommentString() protected метод
Создаёт спецификацию комментария для столбца.
| protected string buildCommentString ( ) | ||
|---|---|---|
| return | string |
Строка, содержащая ключевое слово COMMENT и сам комментарий |
buildFirstString() protected метод
Создаёт первое ограничение для столбца. По умолчанию не поддерживается.
| protected string buildFirstString ( ) | ||
|---|---|---|
| return | string |
Строка, содержащая ограничение FIRST. |
buildUnsignedString() protected метод
Создаёт строку UNSIGNED для столбца. По умолчанию не поддерживается.
| protected string buildUnsignedString ( ) | ||
|---|---|---|
| return | string |
Строка, содержащая ключевое слово UNSIGNED. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-db-cubrid-columnschemabuilder.html
