Class yii\db\ColumnSchemaBuilder

ColumnSchemaBuilder helps to define database schema types using a PHP interface.

See yii\db\SchemaBuilderTrait for more detailed description and usage examples.

Public Properties

Protected Properties

Public Methods

Protected Methods

Constants

Property Details

$after protected property (available since version 2.0.8)

The column after which this column will be added.

protected string $after = null

$append protected property (available since version 2.0.9)

SQL string to be appended to column schema definition.

protected mixed $append = null

$categoryMap public property (available since version 2.0.8)

Mapping of abstract column types (keys) to type categories (values).

public array $categoryMap = [\yii\db\Schema::TYPE_PK => self::CATEGORY_PK, \yii\db\Schema::TYPE_UPK => self::CATEGORY_PK, \yii\db\Schema::TYPE_BIGPK => self::CATEGORY_PK, \yii\db\Schema::TYPE_UBIGPK => self::CATEGORY_PK, \yii\db\Schema::TYPE_CHAR => self::CATEGORY_STRING, \yii\db\Schema::TYPE_STRING => self::CATEGORY_STRING, \yii\db\Schema::TYPE_TEXT => self::CATEGORY_STRING, \yii\db\Schema::TYPE_SMALLINT => self::CATEGORY_NUMERIC, \yii\db\Schema::TYPE_INTEGER => self::CATEGORY_NUMERIC, \yii\db\Schema::TYPE_BIGINT => self::CATEGORY_NUMERIC, \yii\db\Schema::TYPE_FLOAT => self::CATEGORY_NUMERIC, \yii\db\Schema::TYPE_DOUBLE => self::CATEGORY_NUMERIC, \yii\db\Schema::TYPE_DECIMAL => self::CATEGORY_NUMERIC, \yii\db\Schema::TYPE_DATETIME => self::CATEGORY_TIME, \yii\db\Schema::TYPE_TIMESTAMP => self::CATEGORY_TIME, \yii\db\Schema::TYPE_TIME => self::CATEGORY_TIME, \yii\db\Schema::TYPE_DATE => self::CATEGORY_TIME, \yii\db\Schema::TYPE_BINARY => self::CATEGORY_OTHER, \yii\db\Schema::TYPE_BOOLEAN => self::CATEGORY_NUMERIC, \yii\db\Schema::TYPE_MONEY => self::CATEGORY_NUMERIC]

$check protected property

The CHECK constraint for the column.

protected string $check = null

$comment public property (available since version 2.0.8)

Comment value of the column.

public string $comment = null

$db public property (available since version 2.0.8)

The current database connection. It is used mainly to escape strings safely when building the final column schema string.

public yii\db\Connection $db = null

$default protected property

Default value of the column.

protected mixed $default = null

$isFirst protected property (available since version 2.0.8)

Whether this column is to be inserted at the beginning of the table.

protected boolean $isFirst = null

$isNotNull protected property

Whether the column is or not nullable. If this is true, a NOT NULL constraint will be added. If this is false, a NULL constraint will be added.

protected boolean|null $isNotNull = null

$isUnique protected property

Whether the column values should be unique. If this is true, a UNIQUE constraint will be added.

protected boolean $isUnique = false

$isUnsigned protected property (available since version 2.0.7)

Whether the column values should be unsigned. If this is true, an UNSIGNED keyword will be added.

protected boolean $isUnsigned = false

$length protected property

Column size or precision definition. This is what goes into the parenthesis after the column type. This can be either a string, an integer or an array. If it is an array, the array values will be joined into a string separated by comma.

protected integer|string|array $length = null

$type protected property

The column type definition such as INTEGER, VARCHAR, DATETIME, etc.

protected string $type = null

Method Details