TableDefinition

public final class TableDefinition

The TableDefinition class lets you define table columns and constraints.

You don’t create instances of this class. Instead, you use the Database create(table:) method:

try db.create(table: "players") { t in // t is TableDefinition
    t.column(...)
}

See https://www.sqlite.org/lang_createtable.html


                    
                    
                    column(_:_:)

Appends a table column.

try db.create(table: "players") { t in
    t.column("name", .text)
}

See https://www.sqlite.org/lang_createtable.html#tablecoldef

Declaration

Swift

public func column(_ name: String, _ type: Database.ColumnType? = nil) -> ColumnDefinition

Parameters

`name`	the column name.
`type`	the eventual column type.

Return Value

An ColumnDefinition that allows you to refine the column definition.

Show on GitHub


                    
                    
                    primaryKey(_:onConflict:)

Defines the table primary key.

try db.create(table: "citizenships") { t in
    t.column("citizenID", .integer)
    t.column("countryCode", .text)
    t.primaryKey(["citizenID", "countryCode"])
}

See https://www.sqlite.org/lang_createtable.html#primkeyconst and https://www.sqlite.org/lang_createtable.html#rowid

Declaration

Swift

public func primaryKey(_ columns: [String], onConflict conflictResolution: Database.ConflictResolution? = nil)

Parameters

`columns`	The primary key columns.
`conflitResolution`	An optional conflict resolution (see https://www.sqlite.org/lang_conflict.html).

Show on GitHub


                    
                    
                    uniqueKey(_:onConflict:)

Adds a unique key.

try db.create(table: "pointOfInterests") { t in
    t.column("latitude", .double)
    t.column("longitude", .double)
    t.uniqueKey(["latitude", "longitude"])
}

See https://www.sqlite.org/lang_createtable.html#uniqueconst

Declaration

Swift

public func uniqueKey(_ columns: [String], onConflict conflictResolution: Database.ConflictResolution? = nil)

Parameters

`columns`	The unique key columns.
`conflitResolution`	An optional conflict resolution (see https://www.sqlite.org/lang_conflict.html).

Show on GitHub


                    
                    
                    foreignKey(_:references:columns:onDelete:onUpdate:deferred:)

Adds a foreign key.

try db.create(table: "passport") { t in
    t.column("issueDate", .date)
    t.column("citizenID", .integer)
    t.column("countryCode", .text)
    t.foreignKey(["citizenID", "countryCode"], references: "citizenships", onDelete: .cascade)
}

See https://www.sqlite.org/foreignkeys.html

Declaration

Swift

public func foreignKey(_ columns: [String], references table: String, columns destinationColumns: [String]? = nil, onDelete deleteAction: Database.ForeignKeyAction? = nil, onUpdate updateAction: Database.ForeignKeyAction? = nil, deferred: Bool = false)

Parameters

`columns`	The foreign key columns.
`table`	The referenced table.
`destinationColumns`	The columns in the referenced table. If not specified, the columns of the primary key of the referenced table are used.
`deleteAction`	Optional action when the referenced row is deleted.
`updateAction`	Optional action when the referenced row is updated.
`deferred`	If true, defines a deferred foreign key constraint. See https://www.sqlite.org/foreignkeys.html#fk_deferred.

Show on GitHub


                    
                    
                    check(_:)

Adds a CHECK constraint.

try db.create(table: "players") { t in
    t.column("personalPhone", .text)
    t.column("workPhone", .text)
    let personalPhone = Column("personalPhone")
    let workPhone = Column("workPhone")
    t.check(personalPhone != nil || workPhone != nil)
}

See https://www.sqlite.org/lang_createtable.html#ckconst

Declaration

Swift

public func check(_ condition: SQLExpressible)

Parameters


                                condition

The checked condition

Show on GitHub


                    
                    
                    check(sql:)

Adds a CHECK constraint.

try db.create(table: "players") { t in
    t.column("personalPhone", .text)
    t.column("workPhone", .text)
    t.check(sql: "personalPhone IS NOT NULL OR workPhone IS NOT NULL")
}

See https://www.sqlite.org/lang_createtable.html#ckconst

Declaration

Swift

public func check(sql: String)

Parameters

sql

An SQL snippet

Show on GitHub