MutablePersistableRecord

The policy that handles SQLite conflicts when records are inserted or updated.

This property is optional: its default value uses the ABORT policy for both insertions and updates, and has GRDB generate regular INSERT and UPDATE queries.

If insertions are resolved with .ignore policy, the didInsert(with:for:) method is not called upon successful insertion, even if a row was actually inserted without any conflict.

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

Notifies the record that it was succesfully inserted.

Do not call this method directly: it is called for you, in a protected dispatch queue, with the inserted RowID and the eventual INTEGER PRIMARY KEY column name.

This method is optional: the default implementation does nothing.

struct Player : MutablePersistableRecord {
    var id: Int64?
    var name: String?

    mutating func didInsert(with rowID: Int64, for column: String?) {
        self.id = rowID
    }
}

Executes an INSERT statement.

This method is guaranteed to have inserted a row in the database if it returns without error.

Upon successful insertion, the didInsert(with:for:) method is called with the inserted RowID and the eventual INTEGER PRIMARY KEY column name.

This method has a default implementation, so your adopting types don’t have to implement it. Yet your types can provide their own implementation of insert(). In their implementation, it is recommended that they invoke the performInsert() method.

Executes an UPDATE statement.

This method is guaranteed to have updated a row in the database if it returns without error.

This method has a default implementation, so your adopting types don’t have to implement it. Yet your types can provide their own implementation of update(). In their implementation, it is recommended that they invoke the performUpdate() method.

Executes an INSERT or an UPDATE statement so that self is saved in the database.

If the receiver has a non-nil primary key and a matching row in the database, this method performs an update.

Otherwise, performs an insert.

This method is guaranteed to have inserted or updated a row in the database if it returns without error.

This method has a default implementation, so your adopting types don’t have to implement it. Yet your types can provide their own implementation of save(). In their implementation, it is recommended that they invoke the performSave() method.

Executes a DELETE statement.

This method has a default implementation, so your adopting types don’t have to implement it. Yet your types can provide their own implementation of delete(). In their implementation, it is recommended that they invoke the performDelete() method.

Returns true if and only if the primary key matches a row in the database.

This method has a default implementation, so your adopting types don’t have to implement it. Yet your types can provide their own implementation of exists(). In their implementation, it is recommended that they invoke the performExists() method.

Executes an UPDATE statement that updates all table columns.

If the record has any difference from the other record, executes an UPDATE statement so that those differences and only those difference are saved in the database.

This method is guaranteed to have saved the eventual differences in the database if it returns without error.

For example:

if let oldPlayer = try Player.fetchOne(db, key: 42) {
    var newPlayer = oldPlayer
    newPlayer.score += 10
    newPlayer.hasAward = true
    try newPlayer.updateChanges(db, from: oldRecord)
}

Mutates the record according to the provided closure, and then, if the record has any difference from its previous version, executes an UPDATE statement so that those differences and only those difference are saved in the database.

This method is guaranteed to have saved the eventual differences in the database if it returns without error.

For example:

if var player = try Player.fetchOne(db, key: 42) {
    try player.updateChanges(db) {
        $0.score += 10
        $0.hasAward = true
    }
}

Don’t invoke this method directly: it is an internal method for types that adopt MutablePersistableRecord.

performInsert() provides the default implementation for insert(). Types that adopt MutablePersistableRecord can invoke performInsert() in their implementation of insert(). They should not provide their own implementation of performInsert().

Don’t invoke this method directly: it is an internal method for types that adopt MutablePersistableRecord.

performUpdate() provides the default implementation for update(). Types that adopt MutablePersistableRecord can invoke performUpdate() in their implementation of update(). They should not provide their own implementation of performUpdate().

Don’t invoke this method directly: it is an internal method for types that adopt MutablePersistableRecord.

performSave() provides the default implementation for save(). Types that adopt MutablePersistableRecord can invoke performSave() in their implementation of save(). They should not provide their own implementation of performSave().

This default implementation forwards the job to update or insert.

Don’t invoke this method directly: it is an internal method for types that adopt MutablePersistableRecord.

performDelete() provides the default implementation for deelte(). Types that adopt MutablePersistableRecord can invoke performDelete() in their implementation of delete(). They should not provide their own implementation of performDelete().

Don’t invoke this method directly: it is an internal method for types that adopt MutablePersistableRecord.

performExists() provides the default implementation for exists(). Types that adopt MutablePersistableRecord can invoke performExists() in their implementation of exists(). They should not provide their own implementation of performExists().

Mutates the record according to the provided closure, and then, if the record has any difference from its previous version, executes an UPDATE statement so that those differences and only those difference are saved in the database.

This method is guaranteed to have saved the eventual differences in the database if it returns without error.

For example:

if let player = try Player.fetchOne(db, key: 42) {
    try player.updateChanges(db) {
        $0.score += 10
        $0.hasAward = true
    }
}

Deletes all records; returns the number of deleted rows.

Updates all records; returns the number of updated records.

For example:

try dbQueue.write { db in
    // UPDATE player SET score = 0
    try Player.updateAll(db, [Column("score") <- 0])
}

Updates all records; returns the number of updated records.

For example:

try dbQueue.write { db in
    // UPDATE player SET score = 0
    try Player.updateAll(db, Column("score") <- 0)
}

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

// DELETE FROM player WHERE id IN (1, 2, 3)
try Player.deleteAll(db, keys: [1, 2, 3])

// DELETE FROM country WHERE code IN ('FR', 'US', 'DE')
try Country.deleteAll(db, keys: ["FR", "US", "DE"])

When the table has no explicit primary key, GRDB uses the hidden rowid column:

// DELETE FROM document WHERE rowid IN (1, 2, 3)
try Document.deleteAll(db, keys: [1, 2, 3])

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

// DELETE FROM player WHERE id = 123
try Player.deleteOne(db, key: 123)

// DELETE FROM country WHERE code = 'FR'
try Country.deleteOne(db, key: "FR")

When the table has no explicit primary key, GRDB uses the hidden rowid column:

// DELETE FROM document WHERE rowid = 1
try Document.deleteOne(db, key: 1)

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 Player.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.

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