TableMapping

The name of the database table

This flag tells whether the hidden rowid column should be fetched with other columns.

Its default value is false:

// SELECT * FROM persons
try Person.fetchAll(db)

When true, the rowid column is fetched:

// SELECT *, rowid FROM persons
try Person.fetchAll(db)

Returns a QueryInterfaceRequest with a matching predicate.

// SELECT * FROM books WHERE books MATCH '...'
var request = Book.matching(pattern)

If the selectsRowID type property is true, then the selection includes the hidden rowid column:

// SELECT *, rowid FROM books WHERE books MATCH '...'
var request = Book.matching(pattern)

If the search pattern is nil, the request does not match any database row.

Creates a QueryInterfaceRequest which fetches all records.

// SELECT * FROM persons
var request = Person.all()

If the selectsRowID type property is true, then the selection includes the hidden rowid column:

// SELECT *, rowid FROM persons
var request = Person.all()

Creates a QueryInterfaceRequest which fetches no record.

Creates a QueryInterfaceRequest which selects selection.

// SELECT id, email FROM persons
var request = Person.select(Column("id"), Column("email"))

Creates a QueryInterfaceRequest which selects selection.

// SELECT id, email FROM persons
var request = Person.select([Column("id"), Column("email")])

Creates a QueryInterfaceRequest which selects sql.

// SELECT id, email FROM persons
var request = Person.select(sql: "id, email")

Creates a QueryInterfaceRequest with the provided predicate.

// SELECT * FROM persons WHERE email = 'arthur@example.com'
var request = Person.filter(Column("email") == "arthur@example.com")

If the selectsRowID type property is true, then the selection includes the hidden rowid column:

// SELECT *, rowid FROM persons WHERE email = 'arthur@example.com'
var request = Person.filter(Column("email") == "arthur@example.com")

Creates a QueryInterfaceRequest with the provided predicate.

// SELECT * FROM persons WHERE email = 'arthur@example.com'
var request = Person.filter(sql: "email = ?", arguments: ["arthur@example.com"])

If the selectsRowID type property is true, then the selection includes the hidden rowid column:

// SELECT *, rowid FROM persons WHERE email = 'arthur@example.com'
var request = Person.filter(sql: "email = ?", arguments: ["arthur@example.com"])

Creates a QueryInterfaceRequest sorted according to the provided orderings.

// SELECT * FROM persons ORDER BY name
var request = Person.order(Column("name"))

If the selectsRowID type property is true, then the selection includes the hidden rowid column:

// SELECT *, rowid FROM persons ORDER BY name
var request = Person.order(Column("name"))

Creates a QueryInterfaceRequest sorted according to the provided orderings.

// SELECT * FROM persons ORDER BY name
var request = Person.order([Column("name")])

If the selectsRowID type property is true, then the selection includes the hidden rowid column:

// SELECT *, rowid FROM persons ORDER BY name
var request = Person.order([Column("name")])

Creates a QueryInterfaceRequest sorted according to sql.

// SELECT * FROM persons ORDER BY name
var request = Person.order(sql: "name")

If the selectsRowID type property is true, then the selection includes the hidden rowid column:

// SELECT *, rowid FROM persons ORDER BY name
var request = Person.order(sql: "name")

Creates a QueryInterfaceRequest which fetches limit rows, starting at offset.

// SELECT * FROM persons LIMIT 1
var request = Person.limit(1)

If the selectsRowID type property is true, then the selection includes the hidden rowid column:

// SELECT *, rowid FROM persons LIMIT 1
var request = Person.limit(1)

The number of records.

Deletes all records; returns the number of deleted rows.

Delete records identified by their primary keys; returns the number of deleted rows.

try Person.deleteAll(db, keys: [1, 2, 3])

Delete a record, identified by its primary key; returns whether a database row was deleted.

try Person.deleteOne(db, key: 123)

Delete records identified by the provided unique keys (primary key or any key with a unique index on it); returns the number of deleted rows.

try Person.deleteAll(db, keys: [["email": "a@example.com"], ["email": "b@example.com"]])

Delete a record, identified by a unique key (the primary key or any key with a unique index on it); returns whether a database row was deleted.

Person.deleteOne(db, key: ["name": Arthur"])

Returns a function that returns true if and only if two rows have the same primary key and both primary keys contain at least one non-null value.

try dbQueue.inDatabase { db in
    let comparator = try Person.primaryKeyRowComparator(db)
    let row0 = Row(["id": nil, "name": "Unsaved"])
    let row1 = Row(["id": 1, "name": "Arthur"])
    let row2 = Row(["id": 1, "name": "Arthur"])
    let row3 = Row(["id": 2, "name": "Barbara"])
    comparator(row0, row0) // false
    comparator(row1, row2) // true
    comparator(row1, row3) // false
}