From 20818ee819459a799b74eb3eaab7ef57e674a6e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gwendal=20Roue=CC=81?= Date: Sat, 28 Sep 2024 13:34:26 +0200 Subject: [PATCH] Remove the Record class from the documentation --- Documentation/AssociationsBasics.md | 5 +- GRDB/Documentation.docc/QueryInterface.md | 7 +- GRDB/Record/Record.swift | 4 + README.md | 450 +++------------------- 4 files changed, 59 insertions(+), 407 deletions(-) diff --git a/Documentation/AssociationsBasics.md b/Documentation/AssociationsBasics.md index 50e241674f..e37565ce75 100644 --- a/Documentation/AssociationsBasics.md +++ b/Documentation/AssociationsBasics.md @@ -137,9 +137,7 @@ Before we dive in, please remember that associations can not generate all possib **Associations are available on types that adopt the necessary supporting protocols.** -When your record type is a subclass of the [Record class], all necessary protocols are already setup and ready: you can skip this chapter. - -Generally speaking, associations use the [TableRecord], [FetchableRecord], and [EncodableRecord] protocols: +Associations are based on the [TableRecord], [FetchableRecord], and [EncodableRecord] protocols: - **[TableRecord]** is the protocol that lets you declare associations between record types: @@ -3005,7 +3003,6 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. [TableRecord]: ../README.md#tablerecord-protocol [Recommended Practices for Designing Record Types]: https://swiftpackageindex.com/groue/grdb.swift/documentation/grdb/recordrecommendedpractices [regular aggregating methods]: ../README.md#fetching-aggregated-values -[Record class]: ../README.md#record-class [EncodableRecord]: ../README.md#persistablerecord-protocol [PersistableRecord]: ../README.md#persistablerecord-protocol [Codable Records]: ../README.md#codable-records diff --git a/GRDB/Documentation.docc/QueryInterface.md b/GRDB/Documentation.docc/QueryInterface.md index f09b20f473..e169324418 100644 --- a/GRDB/Documentation.docc/QueryInterface.md +++ b/GRDB/Documentation.docc/QueryInterface.md @@ -8,9 +8,8 @@ For an overview, see [Records](https://github.com/groue/GRDB.swift/blob/master/R ## Topics -### Records +### Records Protocols -- ``Record`` - ``EncodableRecord`` - ``FetchableRecord`` - ``MutablePersistableRecord`` @@ -48,3 +47,7 @@ For an overview, see [Records](https://github.com/groue/GRDB.swift/blob/master/R - ``SQLSubqueryable`` - ``SQLOrderingTerm`` - ``SQLSelectable`` + +### Legacy Types + +- ``Record`` diff --git a/GRDB/Record/Record.swift b/GRDB/Record/Record.swift index 7d0644e731..ee029b805a 100644 --- a/GRDB/Record/Record.swift +++ b/GRDB/Record/Record.swift @@ -2,6 +2,10 @@ /// A base class for types that can be fetched and persisted in the database. /// +/// ## Overview +/// +/// - warning: `Record` is a legacy GRDB type. Since GRDB 7, it is not recommended to define record types by subclassing the `Record` class. See for more information. +/// /// ## Topics /// /// ### Creating Record Instances diff --git a/README.md b/README.md index 8bfa611418..e2af80cf74 100644 --- a/README.md +++ b/README.md @@ -1662,7 +1662,7 @@ try dbQueue.read { db in Records ======= -**On top of the [SQLite API](#sqlite-api), GRDB provides protocols and a class** that help manipulating database rows as regular objects named "records": +**On top of the [SQLite API](#sqlite-api), GRDB provides protocols** that help manipulating database rows as regular objects named "records": ```swift try dbQueue.write { db in @@ -1675,15 +1675,31 @@ try dbQueue.write { db in Of course, you need to open a [database connection], and [create database tables](https://swiftpackageindex.com/groue/grdb.swift/documentation/grdb/databaseschema) first. -To define your custom records, you subclass the ready-made `Record` class, or you extend your structs and classes with protocols that come with focused sets of features: fetching methods, persistence methods, record comparison... +To define a record type, define a type and extend it with protocols that come with focused sets of features. -Extending structs with record protocols is more "swifty". Subclassing the Record class is more "classic". You can choose either way. See some [examples of record definitions](#examples-of-record-definitions), and the [list of record methods](#list-of-record-methods) for an overview. +For example: + +``` +struct Player: { + var id: Int64 + var name: String + var score: Int +} + +// Players can be fetched from the database. +extension Player: FetchableRecord { ... } + +// Players can be saved into the database. +extension Player: PersistableRecord { ... } +``` + +See some [examples of record definitions](#examples-of-record-definitions). -> **Note**: if you are familiar with Core Data's NSManagedObject or Realm's Object, you may experience a cultural shock: GRDB records are not uniqued, do not auto-update, and do not lazy-load. This is both a purpose, and a consequence of protocol-oriented programming. You should read [How to build an iOS application with SQLite and GRDB.swift](https://medium.com/@gwendal.roue/how-to-build-an-ios-application-with-sqlite-and-grdb-swift-d023a06c29b3) for a general introduction. +> Note: if you are familiar with Core Data's NSManagedObject or Realm's Object, you may experience a cultural shock: GRDB records are not uniqued, do not auto-update, and do not lazy-load. This is both a purpose, and a consequence of protocol-oriented programming. > -> :bulb: **Tip**: after you have read this chapter, check the [Recommended Practices for Designing Record Types](https://swiftpackageindex.com/groue/grdb.swift/documentation/grdb/recordrecommendedpractices) Guide. +> Tip: The [Recommended Practices for Designing Record Types](https://swiftpackageindex.com/groue/grdb.swift/documentation/grdb/recordrecommendedpractices) guide provides general guidance.. > -> :bulb: **Tip**: see the [Demo Applications] for sample apps that uses records. +> Tip: See the [Demo Applications] for sample apps that uses records. **Overview** @@ -1704,16 +1720,10 @@ Extending structs with record protocols is more "swifty". Subclassing the Record - [Persistence Callbacks] - [Identifiable Records] - [Codable Records] -- [Record Class](#record-class) - [Record Comparison] - [Record Customization Options] - [Record Timestamps and Transaction Date] -**Records in a Glance** - -- [Examples of Record Definitions](#examples-of-record-definitions) -- [List of Record Methods](#list-of-record-methods) - ### Inserting Records @@ -1724,7 +1734,7 @@ let player = Player(name: "Arthur", email: "arthur@example.com") try player.insert(db) ``` -:point_right: `insert` is available for subclasses of the [Record](#record-class) class, and types that adopt the [PersistableRecord] protocol. +:point_right: `insert` is available for types that adopt the [PersistableRecord] protocol. ### Fetching Records @@ -1745,9 +1755,9 @@ let spain = try Country.fetchOne(db, id: "ES") // Country? let italy = try Country.find(db, id: "IT") // Country ``` -:point_right: Fetching from raw SQL is available for subclasses of the [Record](#record-class) class, and types that adopt the [FetchableRecord] protocol. +:point_right: Fetching from raw SQL is available for types that adopt the [FetchableRecord] protocol. -:point_right: Fetching without SQL, using the [query interface](#the-query-interface), is available for subclasses of the [Record](#record-class) class, and types that adopt both [FetchableRecord] and [TableRecord] protocol. +:point_right: Fetching without SQL, using the [query interface](#the-query-interface), is available for types that adopt both [FetchableRecord] and [TableRecord] protocol. ### Updating Records @@ -1777,7 +1787,7 @@ try Player .updateAll(db, Column("score") += 1) ``` -:point_right: update methods are available for subclasses of the [Record](#record-class) class, and types that adopt the [PersistableRecord] protocol. Batch updates are available on the [TableRecord] protocol. +:point_right: update methods are available for types that adopt the [PersistableRecord] protocol. Batch updates are available on the [TableRecord] protocol. ### Deleting Records @@ -1800,7 +1810,7 @@ try Player .deleteAll(db) ``` -:point_right: delete methods are available for subclasses of the [Record](#record-class) class, and types that adopt the [PersistableRecord] protocol. Batch deletes are available on the [TableRecord] protocol. +:point_right: delete methods are available for types that adopt the [PersistableRecord] protocol. Batch deletes are available on the [TableRecord] protocol. ### Counting Records @@ -1815,7 +1825,7 @@ let playerWithEmailCount: Int = try Player .fetchCount(db) ``` -:point_right: `fetchCount` is available for subclasses of the [Record](#record-class) class, and types that adopt the [TableRecord] protocol. +:point_right: `fetchCount` is available for types that adopt the [TableRecord] protocol. Details follow: @@ -1826,11 +1836,9 @@ Details follow: - [PersistableRecord Protocol](#persistablerecord-protocol) - [Identifiable Records] - [Codable Records] -- [Record Class](#record-class) - [Record Comparison] - [Record Customization Options] - [Examples of Record Definitions](#examples-of-record-definitions) -- [List of Record Methods](#list-of-record-methods) ## Record Protocols Overview @@ -1841,6 +1849,7 @@ Details follow: ```swift struct Place: FetchableRecord { ... } + let places = try dbQueue.read { db in try Place.fetchAll(db, sql: "SELECT * FROM place") } @@ -1854,6 +1863,7 @@ Details follow: ```swift struct Place: TableRecord { ... } + let placeCount = try dbQueue.read { db in // Generates and runs `SELECT COUNT(*) FROM place` try Place.fetchCount(db) @@ -1864,6 +1874,7 @@ Details follow: ```swift struct Place: TableRecord, FetchableRecord { ... } + try dbQueue.read { db in let places = try Place.order(Column("title")).fetchAll(db) let paris = try Place.fetchOne(id: 1) @@ -1874,6 +1885,7 @@ Details follow: ```swift struct Place : PersistableRecord { ... } + try dbQueue.write { db in try Place.delete(db, id: 1) try Place(...).insert(db) @@ -1898,7 +1910,7 @@ protocol FetchableRecord { } ``` -**To use FetchableRecord**, subclass the [Record](#record-class) class, or adopt it explicitly. For example: +For example: ```swift struct Place { @@ -1969,7 +1981,7 @@ See [fetching methods](#fetching-methods) for information about the `fetchCursor 📖 [`TableRecord`](https://swiftpackageindex.com/groue/grdb.swift/documentation/grdb/tablerecord) -**The TableRecord protocol** generates SQL for you. To use TableRecord, subclass the [Record](#record-class) class, or adopt it explicitly: +**The TableRecord protocol** generates SQL for you: ```swift protocol TableRecord { @@ -1984,6 +1996,7 @@ The `databaseTableName` type property is the name of a database table. By defaul ```swift struct Place: TableRecord { } + print(Place.databaseTableName) // prints "place" ``` @@ -2001,16 +2014,8 @@ You can still provide a custom table name: struct Place: TableRecord { static let databaseTableName = "location" } -print(Place.databaseTableName) // prints "location" -``` -Subclasses of the [Record](#record-class) class must always override their superclass's `databaseTableName` property: - -```swift -class Place: Record { - override class var databaseTableName: String { "place" } -} -print(Place.databaseTableName) // prints "place" +print(Place.databaseTableName) // prints "location" ``` When a type adopts both TableRecord and [FetchableRecord](#fetchablerecord-protocol), it can be fetched using the [query interface](#the-query-interface): @@ -2064,7 +2069,7 @@ The `encode(to:)` method defines which [values](#values) (Bool, Int, String, Dat The optional `didInsert` method lets the adopting type store its rowID after successful insertion, and is only useful for tables that have an auto-incremented primary key. It is called from a protected dispatch queue, and serialized with all database updates. -**To use the persistable protocols**, subclass the [Record](#record-class) class, or adopt one of them explicitly. For example: +For example: ```swift extension Place : MutablePersistableRecord { @@ -2127,7 +2132,7 @@ struct Player: Encodable, MutablePersistableRecord { ### Persistence Methods -[Record](#record-class) subclasses and types that adopt [PersistableRecord] are given methods that insert, update, and delete: +Types that adopt the [PersistableRecord] protocol are given methods that insert, update, and delete: ```swift // INSERT @@ -2141,7 +2146,6 @@ try place.update(db, columns: ["title"]) // Maybe UPDATE try place.updateChanges(db, from: otherPlace) try place.updateChanges(db) { $0.isFavorite = true } -try place.updateChanges(db) // Record class only // INSERT or UPDATE try place.save(db) @@ -2413,20 +2417,6 @@ try dbQueue.write { db in } ``` -When you subclass the [Record](#record-class) class, override the callback, and make sure you call `super` at some point of your implementation: - -```swift -class Player: Record { - var id: Int64? - - // Update auto-incremented id upon successful insertion - func didInsert(_ inserted: InsertionSuccess) { - super.didInsert(inserted) - id = inserted.rowID - } -} -``` - Callbacks can also help implementing record validation: ```swift @@ -2521,7 +2511,7 @@ try Player.deleteOne(db, id: 1) try Player.deleteAll(db, ids: [1, 2, 3]) ``` -> **Note**: `Identifiable` is not available on all application targets, and not all tables have a single-column primary key. GRDB provides other methods that deal with primary and unique keys, but they won't check the type of their arguments: +> **Note**: Not all record types can be made `Identifiable`, and not all tables have a single-column primary key. GRDB provides other methods that deal with primary and unique keys, but they won't check the type of their arguments: > > ```swift > // Available on non-Identifiable types @@ -2832,64 +2822,6 @@ extension Player: FetchableRecord, PersistableRecord { See the [query interface](#the-query-interface) and [Recommended Practices for Designing Record Types](https://swiftpackageindex.com/groue/grdb.swift/documentation/grdb/recordrecommendedpractices) for further information. -## Record Class - -**Record** is a class that is designed to be subclassed. It inherits its features from the [FetchableRecord, TableRecord, and PersistableRecord](#record-protocols-overview) protocols. On top of that, Record instances can compare against previous versions of themselves in order to [avoid useless updates](#record-comparison). - -Record subclasses define their custom database relationship by overriding database methods. For example: - -```swift -class Place: Record { - var id: Int64? - var title: String - var isFavorite: Bool - var coordinate: CLLocationCoordinate2D - - init(id: Int64?, title: String, isFavorite: Bool, coordinate: CLLocationCoordinate2D) { - self.id = id - self.title = title - self.isFavorite = isFavorite - self.coordinate = coordinate - super.init() - } - - /// The table name - override class var databaseTableName: String { "place" } - - /// The table columns - enum Columns: String, ColumnExpression { - case id, title, favorite, latitude, longitude - } - - /// Creates a record from a database row - required init(row: Row) throws { - id = row[Columns.id] - title = row[Columns.title] - isFavorite = row[Columns.favorite] - coordinate = CLLocationCoordinate2D( - latitude: row[Columns.latitude], - longitude: row[Columns.longitude]) - try super.init(row: row) - } - - /// The values persisted in the database - override func encode(to container: inout PersistenceContainer) throws { - container[Columns.id] = id - container[Columns.title] = title - container[Columns.favorite] = isFavorite - container[Columns.latitude] = coordinate.latitude - container[Columns.longitude] = coordinate.longitude - } - - /// Update record ID after a successful insertion - override func didInsert(_ inserted: InsertionSuccess) { - super.didInsert(inserted) - id = inserted.rowID - } -} -``` - - ## Record Comparison **Records that adopt the [EncodableRecord] protocol can compare against other records, or against previous versions of themselves.** @@ -2938,23 +2870,6 @@ The `updateChanges` methods perform a database update of the changed columns onl } ``` -- `updateChanges(_:)` (Record class only) - - Instances of the [Record](#record-class) class are able to compare against themselves, and know if they have changes that have not been saved since the last fetch or saving: - - ```swift - // Record class only - if let player = try Player.fetchOne(db, id: 42) { - player.score = 100 - if try player.updateChanges(db) { - print("player was modified, and updated in the database") - } else { - print("player was not modified, and database was not hit") - } - } - ``` - - ### The `databaseEquals` Method This method returns whether two records have the same database representation: @@ -2983,46 +2898,6 @@ for (column, oldValue) in try newPlayer.databaseChanges(from: oldPlayer) { // prints "score was 100" ``` -The [Record](#record-class) class is able to compare against itself: - -```swift -// Record class only -let player = Player(id: 1, name: "Arthur", score: 100) -try player.insert(db) -player.score = 1000 -for (column, oldValue) in try player.databaseChanges { - print("\(column) was \(oldValue)") -} -// prints "score was 100" -``` - -[Record](#record-class) instances also have a `hasDatabaseChanges` property: - -```swift -// Record class only -player.score = 1000 -if player.hasDatabaseChanges { - try player.save(db) -} -``` - -`Record.hasDatabaseChanges` is false after a Record instance has been fetched or saved into the database. Subsequent modifications may set it, or not: `hasDatabaseChanges` is based on value comparison. **Setting a property to the same value does not set the changed flag**: - -```swift -let player = Player(name: "Barbara", score: 750) -player.hasDatabaseChanges // true - -try player.insert(db) -player.hasDatabaseChanges // false - -player.name = "Barbara" -player.hasDatabaseChanges // false - -player.score = 1000 -player.hasDatabaseChanges // true -try player.databaseChanges // ["score": 750] -``` - For an efficient algorithm which synchronizes the content of a database table with a JSON payload, check [groue/SortedDifference](https://github.com/groue/SortedDifference). @@ -3340,241 +3215,6 @@ extension Place: MutablePersistableRecord { -
- Subclass the Record class - -See the [Record class](#record-class) for more information. - -```swift -class Place: Record { - var id: Int64? - var title: String - var isFavorite: Bool - var coordinate: CLLocationCoordinate2D - - init(id: Int64?, title: String, isFavorite: Bool, coordinate: CLLocationCoordinate2D) { - self.id = id - self.title = title - self.isFavorite = isFavorite - self.coordinate = coordinate - super.init() - } - - /// The table name - override class var databaseTableName: String { "place" } - - /// The table columns - enum Columns: String, ColumnExpression { - case id, title, isFavorite, latitude, longitude - } - - /// Creates a record from a database row - required init(row: Row) throws { - id = row[Columns.id] - title = row[Columns.title] - isFavorite = row[Columns.isFavorite] - coordinate = CLLocationCoordinate2D( - latitude: row[Columns.latitude], - longitude: row[Columns.longitude]) - try super.init(row: row) - } - - /// The values persisted in the database - override func encode(to container: inout PersistenceContainer) throws { - container[Columns.id] = id - container[Columns.title] = title - container[Columns.isFavorite] = isFavorite - container[Columns.latitude] = coordinate.latitude - container[Columns.longitude] = coordinate.longitude - } - - // Update auto-incremented id upon successful insertion - override func didInsert(_ inserted: InsertionSuccess) { - super.didInsert(inserted) - id = inserted.rowID - } -} -``` - -
- - -## List of Record Methods - -This is the list of record methods, along with their required protocols. The [Record](#record-class) class adopts all these protocols, and adds a few extra methods. - -| Method | Protocols | Notes | -| ------ | --------- | :---: | -| **Core Methods** | | | -| `init(row:)` | [FetchableRecord] | | -| `Type.databaseTableName` | [TableRecord] | | -| `Type.databaseSelection` | [TableRecord] | [*](#columns-selected-by-a-request) | -| `Type.persistenceConflictPolicy` | [PersistableRecord] | [*](#conflict-resolution) | -| `record.encode(to:)` | [EncodableRecord] | | -| **Insert and Update Records** | | | -| `record.insert(db)` | [PersistableRecord] | | -| `record.insertAndFetch(db)` | [PersistableRecord] & [FetchableRecord] | | -| `record.insertAndFetch(_:as:)` | [PersistableRecord] | | -| `record.insertAndFetch(_:selection:fetch:)` | [PersistableRecord] | | -| `record.inserted(db)` | [PersistableRecord] | | -| `record.save(db)` | [PersistableRecord] | | -| `record.saveAndFetch(db)` | [PersistableRecord] & [FetchableRecord] | | -| `record.saveAndFetch(_:as:)` | [PersistableRecord] | | -| `record.saveAndFetch(_:selection:fetch:)` | [PersistableRecord] | | -| `record.saved(db)` | [PersistableRecord] | | -| `record.update(db)` | [PersistableRecord] | | -| `record.updateAndFetch(db)` | [PersistableRecord] & [FetchableRecord] | | -| `record.updateAndFetch(_:as:)` | [PersistableRecord] | | -| `record.updateAndFetch(_:selection:fetch:)` | [PersistableRecord] | | -| `record.update(db, columns:...)` | [PersistableRecord] | | -| `record.updateAndFetch(_:columns:selection:fetch:)` | [PersistableRecord] | | -| `record.updateChanges(db, from:...)` | [PersistableRecord] | [*](#record-comparison) | -| `record.updateChanges(db) { ... }` | [PersistableRecord] | [*](#record-comparison) | -| `record.updateChangesAndFetch(_:columns:as:modify:)` | [PersistableRecord] | | -| `record.updateChangesAndFetch(_:columns:selection:fetch:modify:)` | [PersistableRecord] | | -| `record.updateChanges(db)` | [Record](#record-class) | [*](#record-comparison) | -| `record.upsert(db)` | [PersistableRecord] | | -| `record.upsertAndFetch(db)` | [PersistableRecord] & [FetchableRecord] | | -| `record.upsertAndFetch(_:as:)` | [PersistableRecord] | | -| `Type.updateAll(db, ...)` | [TableRecord] | | -| `Type.filter(...).updateAll(db, ...)` | [TableRecord] | ² | -| **Delete Records** | | | -| `record.delete(db)` | [PersistableRecord] | | -| `Type.deleteOne(db, key:...)` | [TableRecord] | ¹ | -| `Type.deleteOne(db, id:...)` | [TableRecord] & [Identifiable] | ¹ | -| `Type.deleteAll(db)` | [TableRecord] | | -| `Type.deleteAll(db, keys:...)` | [TableRecord] | ¹ | -| `Type.deleteAll(db, ids:...)` | [TableRecord] & [Identifiable] | ¹ | -| `Type.filter(...).deleteAll(db)` | [TableRecord] | ² | -| **Persistence Callbacks** | | | -| `record.willInsert(_:)` | [PersistableRecord] | | -| `record.aroundInsert(_:insert:)` | [PersistableRecord] | | -| `record.didInsert(_:)` | [PersistableRecord] | | -| `record.willUpdate(_:columns:)` | [PersistableRecord] | | -| `record.aroundUpdate(_:columns:update:)` | [PersistableRecord] | | -| `record.didUpdate(_:)` | [PersistableRecord] | | -| `record.willSave(_:)` | [PersistableRecord] | | -| `record.aroundSave(_:save:)` | [PersistableRecord] | | -| `record.didSave(_:)` | [PersistableRecord] | | -| `record.willDelete(_:)` | [PersistableRecord] | | -| `record.aroundDelete(_:delete:)` | [PersistableRecord] | | -| `record.didDelete(deleted:)` | [PersistableRecord] | | -| **Check Record Existence** | | | -| `record.exists(db)` | [PersistableRecord] | | -| `Type.exists(db, key: ...)` | [TableRecord] | ¹ | -| `Type.exists(db, id: ...)` | [TableRecord] & [Identifiable] | ¹ | -| `Type.filter(...).isEmpty(db)` | [TableRecord] | ² | -| **Convert Record to Dictionary** | | | -| `record.databaseDictionary` | [EncodableRecord] | | -| **Count Records** | | | -| `Type.fetchCount(db)` | [TableRecord] | | -| `Type.filter(...).fetchCount(db)` | [TableRecord] | ² | -| **Fetch Record [Cursors](#cursors)** | | | -| `Type.fetchCursor(db)` | [FetchableRecord] & [TableRecord] | | -| `Type.fetchCursor(db, keys:...)` | [FetchableRecord] & [TableRecord] | ¹ | -| `Type.fetchCursor(db, ids:...)` | [FetchableRecord] & [TableRecord] & [Identifiable] | ¹ | -| `Type.fetchCursor(db, sql: sql)` | [FetchableRecord] | ³ | -| `Type.fetchCursor(statement)` | [FetchableRecord] | ⁴ | -| `Type.filter(...).fetchCursor(db)` | [FetchableRecord] & [TableRecord] | ² | -| **Fetch Record Arrays** | | | -| `Type.fetchAll(db)` | [FetchableRecord] & [TableRecord] | | -| `Type.fetchAll(db, keys:...)` | [FetchableRecord] & [TableRecord] | ¹ | -| `Type.fetchAll(db, ids:...)` | [FetchableRecord] & [TableRecord] & [Identifiable] | ¹ | -| `Type.fetchAll(db, sql: sql)` | [FetchableRecord] | ³ | -| `Type.fetchAll(statement)` | [FetchableRecord] | ⁴ | -| `Type.filter(...).fetchAll(db)` | [FetchableRecord] & [TableRecord] | ² | -| **Fetch Record Sets** | | | -| `Type.fetchSet(db)` | [FetchableRecord] & [TableRecord] | | -| `Type.fetchSet(db, keys:...)` | [FetchableRecord] & [TableRecord] | ¹ | -| `Type.fetchSet(db, ids:...)` | [FetchableRecord] & [TableRecord] & [Identifiable] | ¹ | -| `Type.fetchSet(db, sql: sql)` | [FetchableRecord] | ³ | -| `Type.fetchSet(statement)` | [FetchableRecord] | ⁴ | -| `Type.filter(...).fetchSet(db)` | [FetchableRecord] & [TableRecord] | ² | -| **Fetch Individual Records** | | | -| `Type.fetchOne(db)` | [FetchableRecord] & [TableRecord] | | -| `Type.fetchOne(db, key:...)` | [FetchableRecord] & [TableRecord] | ¹ | -| `Type.fetchOne(db, id:...)` | [FetchableRecord] & [TableRecord] & [Identifiable] | ¹ | -| `Type.fetchOne(db, sql: sql)` | [FetchableRecord] | ³ | -| `Type.fetchOne(statement)` | [FetchableRecord] | ⁴ | -| `Type.filter(...).fetchOne(db)` | [FetchableRecord] & [TableRecord] | ² | -| `Type.find(db, key:...)` | [FetchableRecord] & [TableRecord] | ¹ | -| `Type.find(db, id:...)` | [FetchableRecord] & [TableRecord] & [Identifiable] | ¹ | -| **[Codable Records]** | | | -| `Type.databaseDecodingUserInfo` | [FetchableRecord] | [*](#the-userinfo-dictionary) | -| `Type.databaseJSONDecoder(for:)` | [FetchableRecord] | [*](#json-columns) | -| `Type.databaseDateDecodingStrategy` | [FetchableRecord] | [*](#data-date-and-uuid-coding-strategies) | -| `Type.databaseEncodingUserInfo` | [EncodableRecord] | [*](#the-userinfo-dictionary) | -| `Type.databaseJSONEncoder(for:)` | [EncodableRecord] | [*](#json-columns) | -| `Type.databaseDateEncodingStrategy` | [EncodableRecord] | [*](#data-date-and-uuid-coding-strategies) | -| `Type.databaseUUIDEncodingStrategy` | [EncodableRecord] | [*](#data-date-and-uuid-coding-strategies) | -| **Define [Associations]** | | | -| `Type.belongsTo(...)` | [TableRecord] | [*](Documentation/AssociationsBasics.md) | -| `Type.hasMany(...)` | [TableRecord] | [*](Documentation/AssociationsBasics.md) | -| `Type.hasOne(...)` | [TableRecord] | [*](Documentation/AssociationsBasics.md) | -| `Type.hasManyThrough(...)` | [TableRecord] | [*](Documentation/AssociationsBasics.md) | -| `Type.hasOneThrough(...)` | [TableRecord] | [*](Documentation/AssociationsBasics.md) | -| **Building Query Interface [Requests](#requests)** | | | -| `record.request(for:...)` | [TableRecord] & [EncodableRecord] | [*](Documentation/AssociationsBasics.md) | -| `Type.all()` | [TableRecord] | ² | -| `Type.none()` | [TableRecord] | ² | -| `Type.select(...)` | [TableRecord] | ² | -| `Type.select(..., as:...)` | [TableRecord] | ² | -| `Type.selectPrimaryKey(as:...)` | [TableRecord] | ² | -| `Type.annotated(with:...)` | [TableRecord] | ² | -| `Type.filter(...)` | [TableRecord] | ² | -| `Type.filter(id:)` | [TableRecord] & Identifiable | [*](#identifiable-records) | -| `Type.filter(ids:)` | [TableRecord] & Identifiable | [*](#identifiable-records) | -| `Type.matching(...)` | [TableRecord] | ² | -| `Type.including(all:)` | [TableRecord] | ² | -| `Type.including(optional:)` | [TableRecord] | ² | -| `Type.including(required:)` | [TableRecord] | ² | -| `Type.joining(optional:)` | [TableRecord] | ² | -| `Type.joining(required:)` | [TableRecord] | ² | -| `Type.group(...)` | [TableRecord] | ² | -| `Type.groupByPrimaryKey()` | [TableRecord] | ² | -| `Type.having(...)` | [TableRecord] | ² | -| `Type.order(...)` | [TableRecord] | ² | -| `Type.orderByPrimaryKey()` | [TableRecord] | ² | -| `Type.limit(...)` | [TableRecord] | ² | -| `Type.with(...)` | [TableRecord] | ² | -| **[Record Comparison]** | | | -| `record.databaseEquals(...)` | [EncodableRecord] | | -| `record.databaseChanges(from:...)` | [EncodableRecord] | | -| `record.updateChanges(db, from:...)` | [PersistableRecord] | | -| `record.updateChanges(db) { ... }` | [PersistableRecord] | | -| `record.hasDatabaseChanges` | [Record](#record-class) | | -| `record.databaseChanges` | [Record](#record-class) | | -| `record.updateChanges(db)` | [Record](#record-class) | | - -¹ All unique keys are supported: primary keys (single-column, composite, [`rowid`](https://www.sqlite.org/rowidtable.html)) and unique indexes: - -```swift -try Player.fetchOne(db, id: 1) // Player? -try Player.fetchOne(db, key: ["email": "arthur@example.com"]) // Player? -try Country.fetchAll(db, keys: ["FR", "US"]) // [Country] -``` - -² See [Fetch Requests](#requests): - -```swift -let request = Player.filter(emailColumn != nil).order(nameColumn) -let players = try request.fetchAll(db) // [Player] -let count = try request.fetchCount(db) // Int -``` - -³ See [SQL queries](#fetch-queries): - -```swift -let player = try Player.fetchOne(db, sql: "SELECT * FROM player WHERE id = ?", arguments: [1]) // Player? -``` - -⁴ See [`Statement`]: - -```swift -let statement = try db.makeStatement(sql: "SELECT * FROM player WHERE id = ?") -let player = try Player.fetchOne(statement, arguments: [1]) // Player? -``` - The Query Interface =================== @@ -3669,10 +3309,10 @@ let players = try request.fetchAll(db) // [Player] let count = try request.fetchCount(db) // Int ``` -Query interface requests usually start from **a type** that adopts the `TableRecord` protocol, such as a `Record` subclass (see [Records](#records)): +Query interface requests usually start from **a type** that adopts the `TableRecord` protocol: ```swift -class Player: Record { ... } +struct Player: TableRecord { ... } // The request for all players: let request = Player.all() @@ -6309,6 +5949,10 @@ This chapter has [moved](https://swiftpackageindex.com/groue/grdb.swift/document This chapter was replaced with the documentation of [splittingRowAdapters(columnCounts:)](https://swiftpackageindex.com/groue/grdb.swift/documentation/grdb/splittingrowadapters(columncounts:)). +#### List of Record Methods + +See [Records and the Query Interface](https://swiftpackageindex.com/groue/grdb.swift/documentation/grdb/queryinterface). + #### Migrations This chapter has [moved](https://swiftpackageindex.com/groue/grdb.swift/documentation/grdb/migrations). @@ -6329,6 +5973,10 @@ This error was renamed to [RecordError]. This chapter has [moved](https://swiftpackageindex.com/groue/grdb.swift/documentation/grdb/statement). +#### Record Class + +The [`Record`](https://swiftpackageindex.com/groue/grdb.swift/documentation/grdb/record) class is a legacy GRDB type. Since GRDB 7, it is not recommended to define record types by subclassing the `Record` class. + #### Row Adapters This chapter has [moved](https://swiftpackageindex.com/groue/grdb.swift/documentation/grdb/rowadapter).