addRecord()

Signature

addRecord() — returns void

Available in: migration Category: Migration Functions

Description

Adds a record to a table Only available in a migration CFC

Parameters

Name	Type	Required	Default	Description
table	string	yes	—	The table name to add the record to

Examples

// 1. Insert a simple seed record into a settings table
addRecord(
    table = "settings",
    name = "siteName",
    value = "My Wheels App"
);

// 2. Insert a record with multiple columns (extra keyword arguments become column/value pairs)
addRecord(
    table = "people",
    id = 1,
    title = "Mr",
    firstName = "Bruce",
    lastName = "Wayne",
    email = "bruce@wayneenterprises.com",
    phone = "555-678-9099"
);

// 3. Seed an admin user role during a migration's up() function
component extends="wheels.migrator.Migration" {
    function up() {
        addRecord(
            table = "roles",
            id = 1,
            name = "admin",
            active = true
        );
    }
    function down() {
        removeRecord(table = "roles", where = "id = 1");
    }
}