ColumnSchemaBuilder

API reference › yii › db › mssql › ColumnSchemaBuilder

class	`yii\db\mssql\ColumnSchemaBuilder`
Extends	`yii\db\ColumnSchemaBuilder` » `yii\base\BaseObject`
Implements	`Stringable`, `yii\base\Configurable`
Since	2.0.42
Source	`framework/db/mssql/ColumnSchemaBuilder.php`

ColumnSchemaBuilder is the schema builder for MSSQL databases.

Properties

Property	Type	Description	Defined by
`$categoryMap`	`array`	Mapping of abstract column types (keys) to type categories (values).	`yii\db\ColumnSchemaBuilder`
`$checkValue` read-only	`string\|null`	The `CHECK` constraint for the column.	`ColumnSchemaBuilder`
`$comment`	`string`	Comment value of the column. Default: `null`. Available since 2.0.8.	`yii\db\ColumnSchemaBuilder`
`$db`	`yii\db\Connection`	The current database connection. Default: `null`. Available since 2.0.8.	`yii\db\ColumnSchemaBuilder`
`$defaultValue` read-only	`string\|yii\db\Expression\|null`	Default value of the column.	`ColumnSchemaBuilder`
`$typeCategoryMap` static	`array`	Mapping of abstract column types (keys) to type categories (values). Default: [\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_TINYINT => self::CATEGORY_NUMERIC, \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]. Available since 2.0.43.	`yii\db\ColumnSchemaBuilder`
`$typeDefinition` read-only	`string`	Abstract type plus optional length, for example `string(255)`. Available since 22.0.	`yii\db\ColumnSchemaBuilder`
`$after` protected	`string`	The column after which this column will be added. Default: `null`. Available since 2.0.8.	`yii\db\ColumnSchemaBuilder`
`$append` protected	`mixed`	SQL string to be appended to column schema definition. Default: `null`. Available since 2.0.9.	`yii\db\ColumnSchemaBuilder`
`$check` protected	`string`	The `CHECK` constraint for the column. Default: `null`.	`yii\db\ColumnSchemaBuilder`
`$default` protected	`mixed`	Default value of the column. Default: `null`.	`yii\db\ColumnSchemaBuilder`
`$format` protected		Default: `'{type}{length}{notnull}{unique}{default}{check}{append}'`.	`ColumnSchemaBuilder`
`$isFirst` protected	`bool`	Whether this column is to be inserted at the beginning of the table. Default: `null`. Available since 2.0.8.	`yii\db\ColumnSchemaBuilder`
`$isNotNull` protected	`bool\|null`	Whether the column is or not nullable. Default: `null`.	`yii\db\ColumnSchemaBuilder`
`$isUnique` protected	`bool`	Whether the column values should be unique. Default: `false`.	`yii\db\ColumnSchemaBuilder`
`$isUnsigned` protected	`bool`	Whether the column values should be unsigned. Default: `false`. Available since 2.0.7.	`yii\db\ColumnSchemaBuilder`
`$length` protected	`int\|string\|array`	Column size or precision definition. Default: `null`.	`yii\db\ColumnSchemaBuilder`
`$type` protected	`string`	The column type definition such as INTEGER, VARCHAR, DATETIME, etc. Default: `null`.	`yii\db\ColumnSchemaBuilder`

Methods

Method	Description	Defined by
`__construct()`	Create a column schema builder instance giving the type and value precision.	`yii\db\ColumnSchemaBuilder`
`__call()`	Calls the named method which is not a class method.	`yii\base\BaseObject`
`__get()`	Returns the value of an object property.	`yii\base\BaseObject`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\BaseObject`
`__set()`	Sets value of an object property.	`yii\base\BaseObject`
`__toString()`	Builds the full string for the column’s schema.	`ColumnSchemaBuilder`
`__unset()`	Sets an object property to null.	`yii\base\BaseObject`
`after()`	Adds an `AFTER` constraint to the column.	`yii\db\ColumnSchemaBuilder`
`append()`	Specify additional SQL to be appended to column definition.	`yii\db\ColumnSchemaBuilder`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\BaseObject`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\BaseObject`
`check()`	Sets a `CHECK` constraint for the column.	`yii\db\ColumnSchemaBuilder`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`comment()`	Specifies the comment for column.	`yii\db\ColumnSchemaBuilder`
`defaultExpression()`	Specify the default SQL expression for the column.	`yii\db\ColumnSchemaBuilder`
`defaultValue()`	Specify the default value for the column.	`yii\db\ColumnSchemaBuilder`
`first()`	Adds an `FIRST` constraint to the column.	`yii\db\ColumnSchemaBuilder`
`getAppend()`	Returns the raw SQL fragment appended to the column definition.	`yii\db\ColumnSchemaBuilder`
`getCategoryMap()`		`yii\db\ColumnSchemaBuilder`
`getCheck()`	Returns the raw `CHECK` constraint expression of the column.	`yii\db\ColumnSchemaBuilder`
`getCheckValue()`	Get the `Check` value for constraint	`ColumnSchemaBuilder`
`getDefault()`	Returns the raw default value of the column.	`yii\db\ColumnSchemaBuilder`
`getDefaultValue()`	Getting the `Default` value for constraint	`ColumnSchemaBuilder`
`getTypeDefinition()`	Returns the abstract type together with its length or precision, without any constraint keywords.	`yii\db\ColumnSchemaBuilder`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\BaseObject`
`hasProperty()`	Returns a value indicating whether a property is defined.	`yii\base\BaseObject`
`init()`	Initializes the object.	`yii\base\BaseObject`
`isNotNull()`	Returns the nullability state of the column as a tri-state value.	`yii\db\ColumnSchemaBuilder`
`isUnique()`	Returns whether the column carries a `UNIQUE` constraint.	`yii\db\ColumnSchemaBuilder`
`notNull()`	Adds a `NOT NULL` constraint to the column.	`yii\db\ColumnSchemaBuilder`
`null()`	Adds a `NULL` constraint to the column.	`yii\db\ColumnSchemaBuilder`
`setAlterColumnFormat()`	Changes default format string to MSSQL ALTER COMMAND.	`ColumnSchemaBuilder`
`setCategoryMap()`		`yii\db\ColumnSchemaBuilder`
`unique()`	Adds a `UNIQUE` constraint to the column.	`yii\db\ColumnSchemaBuilder`
`unsigned()`	Marks column as unsigned.	`yii\db\ColumnSchemaBuilder`
`buildAfterString()` protected	Builds the after constraint for the column. Defaults to unsupported.	`yii\db\ColumnSchemaBuilder`
`buildAppendString()` protected	Builds the custom string that’s appended to column definition.	`yii\db\ColumnSchemaBuilder`
`buildCheckString()` protected	Builds the check constraint for the column.	`yii\db\ColumnSchemaBuilder`
`buildCommentString()` protected	Builds the comment specification for the column.	`yii\db\ColumnSchemaBuilder`
`buildCompleteString()` protected	Returns the complete column definition from input format.	`yii\db\ColumnSchemaBuilder`
`buildDefaultString()` protected	Builds the default value specification for the column.	`yii\db\ColumnSchemaBuilder`
`buildDefaultValue()` protected	Return the default value for the column.	`yii\db\ColumnSchemaBuilder`
`buildFirstString()` protected	Builds the first constraint for the column. Defaults to unsupported.	`yii\db\ColumnSchemaBuilder`
`buildLengthString()` protected	Builds the length/precision part of the column.	`yii\db\ColumnSchemaBuilder`
`buildNotNullString()` protected	Builds the not null constraint for the column.	`yii\db\ColumnSchemaBuilder`
`buildUniqueString()` protected	Builds the unique constraint for the column.	`yii\db\ColumnSchemaBuilder`
`buildUnsignedString()` protected	Builds the unsigned string for column. Defaults to unsupported.	`yii\db\ColumnSchemaBuilder`
`getTypeCategory()` protected	Returns the category of the column type.	`yii\db\ColumnSchemaBuilder`

Constants

Constant	Value	Defined by
`CATEGORY_PK`	`'pk'`	`yii\db\ColumnSchemaBuilder`
`CATEGORY_STRING`	`'string'`	`yii\db\ColumnSchemaBuilder`
`CATEGORY_NUMERIC`	`'numeric'`	`yii\db\ColumnSchemaBuilder`
`CATEGORY_TIME`	`'time'`	`yii\db\ColumnSchemaBuilder`
`CATEGORY_OTHER`	`'other'`	`yii\db\ColumnSchemaBuilder`

Method details

__toString()

public function __toString(): string

Builds the full string for the column’s schema.

Returns

string

getCheckValue()

public function getCheckValue(): string|null

Get the Check value for constraint

Returns

string|null: The CHECK constraint for the column.

getDefaultValue()

public function getDefaultValue(): string|yii\db\Expression|null

Getting the Default value for constraint

Returns

string|yii\db\Expression|null: Default value of the column.

setAlterColumnFormat()

public function setAlterColumnFormat(): mixed

Changes default format string to MSSQL ALTER COMMAND.

Returns

mixed