Spec-Zone.ru › Yii 2.0

Класс yii\db\sqlite\ColumnSchemaBuilder

Все классы | Свойства | Методы | Константы
Наследование yii\db\sqlite\ColumnSchemaBuilder » yii\db\ColumnSchemaBuilder » yii\base\Object
Реализует yii\base\Configurable
Доступно с версии 2.0.8
Исходный код https://github.com/yiisoft/yii2/blob/master/framework/db/sqlite/ColumnSchemaBuilder.php

ColumnSchemaBuilder — это конструктор схемы для баз данных Sqlite.

Публичные свойства

Свойство Тип Описание Определено в
$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\sqlite\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\ColumnSchemaBuilder
buildAppendString() Создаёт пользовательскую строку, добавляемую к определению столбца. yii\db\ColumnSchemaBuilder
buildCheckString() Создаёт ограничение check для столбца. yii\db\ColumnSchemaBuilder
buildCommentString() Создаёт комментарий к столбцу. yii\db\ColumnSchemaBuilder
buildCompleteString() Возвращает полное определение столбца из входного формата yii\db\ColumnSchemaBuilder
buildDefaultString() Создаёт значение по умолчанию для столбца. yii\db\ColumnSchemaBuilder
buildFirstString() Создаёт первое ограничение для столбца. По умолчанию недоступно. yii\db\ColumnSchemaBuilder
buildLengthString() Создаёт часть определения длины/точности столбца. yii\db\ColumnSchemaBuilder
buildNotNullString() Создаёт ограничение NOT NULL для столбца. yii\db\ColumnSchemaBuilder
buildUniqueString() Создаёт ограничение уникальности для столбца. yii\db\ColumnSchemaBuilder
buildUnsignedString() Создаёт строку UNSIGNED для столбца. По умолчанию недоступно. yii\db\sqlite\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 ( )

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-sqlite-columnschemabuilder.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API