Skip to content

Migrator

column()

column() — returns any

Available in: tabledefinition Category: Table Definition Functions

Adds a column to a table definition in a migration. This function is used when defining or altering database tables. It supports multiple column types and allows you to specify constraints like default values, nullability, length, and precision. Use this inside a table definition object in a migration CFC when building or modifying tables.

NameTypeRequiredDefaultDescription
columnNamestringyes
columnTypestringyes
defaultstringno
allowNullbooleanno
limitanyno
precisionnumericno
scalenumericno
1. Add a string column
t = changeTable(name="employees");
t.column(columnName="fullName", columnType="string", limit=255, allowNull=false, default="Unknown");
t.change();

2. Add a decimal column
t = changeTable(name="products");
t.column(columnName="price", columnType="decimal", precision=10, scale=2, allowNull=false, default="0.00");
t.change();

3. Add a boolean column
t = changeTable(name="members");
t.column(columnName="isActive", columnType="boolean", allowNull=false, default="1");
t.change();