changeTable()

Signature

changeTable() — returns TableDefinition

Available in: migration Category: Migration Functions

Description

Creates a table definition object to store modifications to table properties Only available in a migration CFC

Parameters

Name	Type	Required	Default	Description
name	string	yes	—	Name of the table to set change properties on

Examples

// 1. Add a new string column to an existing table
t = changeTable(name="employees");
t.string(columnNames="fullName", default="", allowNull=true, limit=255);
t.change();

// 2. Modify multiple columns at once (change type and nullability)
t = changeTable(name="products");
t.integer(columnNames="stock", default=0, allowNull=false);
t.boolean(columnNames="active", default=true, allowNull=false);
t.change();

// 3. Add a new column using addColumns=true so the migration fails gracefully if the column already exists
t = changeTable(name="orders");
t.datetime(columnNames="shippedAt", allowNull=true);
t.change(addColumns=true);