Interface Yiisoft\Db\Schema\Column\ColumnInterface

The database assigns auto incremented column a unique value automatically whenever you insert a new row into the table. This is useful for getting unique IDs for data such as customer or employee numbers.

You can set the autoIncrement for INTEGER or BIGINT data types.

If not set explicitly with this method call, the column isn't auto incremented.

$columns = [
    'id' => ColumnBuilder::primaryKey()->autoIncrement(),
];

The check constraint for the column to specify an expression that must be true for each row in the table.

$columns = [
    'age' => ColumnBuilder::integer()->check('age > 0'),
];

The comment for a column in a database table.

The comment can give more information about the purpose or usage of the column.

$columns = [
    'description' => ColumnBuilder::text()->comment('Description of the product'),
];

A computed column is a virtual column that computes its values from an expression.

If not set explicitly with this method call, the column isn't computed.

$columns = [
    'full_name' => ColumnBuilder::text()->computed(true),
];

Sets a database data type for the column.

The data type can be one of the built-in data types supported by the database server (such as INTEGER, VARCHAR, DATETIME, etc.), a custom data type defined by the database server, or null if the database allows untyped columns.

$columns = [
    'description' => ColumnBuilder::text()->dbType('text'),
];

Convert a value from its PHP representation to a database-specific representation.

yiisoft/db calls it automatically by when preparing an SQL statement, so you don't usually need to call it directly in your code.

If the value is null or an \Yiisoft\Db\Schema\Column\Expression, there will be no conversion.

A value that's automatically assigned to a column when you insert a new row into the database table. The default value can be a constant value, function, value derived from other columns, non-computed column name, or their combinations.

$columns = [
    'description' => ColumnBuilder::text()->defaultValue('Description of the product'),
];

Extra SQL to append to the generated SQL for a column.

This can be useful for adding custom constraints or other SQL statements that aren't supported by the column schema itself.

$columns = [
    'updated_at' => ColumnBuilder::integer()->extra('ON UPDATE CURRENT_TIMESTAMP'),
];

Returns the check constraint for the column.

See also check().

See also comment().

See also dbType().

See also defaultValue().

See also extra().

Returns the reference to the foreign key constraint.

See also reference().

See also scale().

See also size().

See also type().

Whether this column is auto incremental.

This is only meaningful when type() is smallint, integer or bigint.

See also autoIncrement().

Whether this column is computed.

See also computed().

Whether this column is not nullable.

See also notNull().

Whether this column is a part of primary key.

See also primaryKey().

Whether this column has a unique index.

See also unique().

Whether this column is unsigned. This is only meaningful when type() is tinyint, smallint, integer or bigint.

See also unsigned().

Whether the column is not nullable.

$columns = [
    'description' => ColumnBuilder::text()->notNull(),
];

Whether the column is nullable. Alias of notNull(false).

Converts the input value after retrieval from the database.

The primary key is a column or set of columns that uniquely identifies each row in a table.

$columns = [
    'id' => ColumnBuilder::primaryKey(),
];

The reference to the foreign key constraint.

$reference = new ForeignKeyConstraint();
$reference->foreignTableName('user');
$reference->foreignColumnNames(['id']);

$columns = [
    'user_id' => ColumnBuilder::integer()->reference($reference),
];

The scale is the number of digits to the right of the decimal point and is only meaningful when type() is decimal.

$columns = [
    'price' => ColumnBuilder::decimal(10, 2)->scale(2),
];

The size refers to the number of characters or digits allowed in a column of a database table. The size is typically used for character or numeric data types, such as VARCHAR, INT or DECIMAL, to specify the maximum length or precision of the data in the column.

$columns = [
    'name' => ColumnBuilder::string()->size(255),
];

The database type of the column.

$columns = [
    'description' => ColumnBuilder::text()->type('text'),
];

Whether the column has a unique index.

$columns = [
    'username' => ColumnBuilder::string()->unique(),
];

Whether the column type is an unsigned integer.

It's a data type that can only represent positive whole numbers only.

$columns = [
    'age' => ColumnBuilder::integer()->unsigned(),
];

Returns a new instance with the specified name of the column.

$columns = [
    'id' => ColumnBuilder::primaryKey()->withName('id'),
];