StructuredQueries

.spi.yml

@@ -3,4 +3,7 @@ builder:
   configs:
   - documentation_targets:
     - SharingGRDB
-    swift_version: 6.0
+    - SharingGRDBCore
+    - StructuredQueriesGRDB
+    - StructuredQueriesGRDBCore
+    custom_documentation_parameters: [--enable-experimental-overloaded-symbol-presentation]

Examples/CaseStudies/Animations.swift

@@ -1,4 +1,3 @@
-import Dependencies
 import SharingGRDB
 import SwiftUI
 
@@ -7,14 +6,14 @@ struct AnimationsCaseStudy: SwiftUICaseStudy {
     This demonstrates how to animate fetching data from the database, or when data changes in \
     the database. Simply provide the `animation` argument to `fetchAll` (or the other querying \
     tools, such as `fetch` and `fetchOne`). 
-    
+
     This is analogous to how animations work in SwiftData in which one provides an `animation` \
     argument to the `@Query` macro.
     """
   let caseStudyTitle = "Animations"
 
-  @SharedReader(.fetchAll(sql: #"SELECT * FROM "facts" ORDER BY "id" DESC"#, animation: .default))
-  private var facts: [Fact]
+  @FetchAll(Fact.order { $0.id.desc() }, animation: .default)
+  private var facts
 
   @Dependency(\.defaultDatabase) var database
 
@@ -36,32 +35,35 @@ struct AnimationsCaseStudy: SwiftUICaseStudy {
             as: UTF8.self
           )
           try await database.write { db in
-            _ = try Fact(body: fact).inserted(db)
+            try Fact.insert(Fact.Draft(body: fact))
+              .execute(db)
           }
         }
       } catch {}
     }
   }
 }
 
-private struct Fact: Codable, FetchableRecord, Identifiable, MutablePersistableRecord {
-  static let databaseTableName = "facts"
-  var id: Int64?
+@Table
+private struct Fact: Identifiable {
+  let id: Int
   var body: String
-  mutating func didInsert(_ inserted: InsertionSuccess) {
-    id = inserted.rowID
-  }
 }
 
 extension DatabaseWriter where Self == DatabaseQueue {
   static var animationDatabase: Self {
     let databaseQueue = try! DatabaseQueue()
     var migrator = DatabaseMigrator()
     migrator.registerMigration("Create 'facts' table") { db in
-      try db.create(table: Fact.databaseTableName) { table in
-        table.autoIncrementedPrimaryKey("id")
-        table.column("body", .text).notNull()
-      }
+      try #sql(
+        """
+        CREATE TABLE "facts" (
+          "id" INTEGER PRIMARY KEY AUTOINCREMENT,
+          "body" TEXT NOT NULL
+        )
+        """
+      )
+      .execute(db)
     }
     try! migrator.migrate(databaseQueue)
     return databaseQueue

Examples/CaseStudies/App.swift

@@ -6,9 +6,11 @@ struct CaseStudiesApp: App {
   var body: some Scene {
     WindowGroup {
       Form {
-        Text("""
+        Text(
+          """
           Open the preview in each case study file to run a case study.
-          """)
+          """
+        )
       }
     }
   }

Examples/CaseStudies/DynamicQuery.swift

@@ -1,4 +1,3 @@
-import Dependencies
 import SharingGRDB
 import SwiftUI
 
@@ -8,13 +7,13 @@ struct DynamicQueryDemo: SwiftUICaseStudy {
     a fact about a number is loaded from the network and saved to a database. You can search the \
     facts for text, and the list will stay in sync so that if a new fact is added to the database \
     that satisfies the search term, it will immediately appear.
-    
-    To accomplish this one can invoke the `load` method defined on the `@SharedReader` projected \
-    value in order to set a new query with dynamic parameters.
+
+    To accomplish this one can invoke the `load` method defined on the `@Fetch` projected value in \
+    order to set a new query with dynamic parameters.
     """
   let caseStudyTitle = "Dynamic Query"
 
-  @State.SharedReader(.fetch(Facts(), animation: .default)) private var facts = Facts.Value()
+  @Fetch(Facts(), animation: .default) private var facts = Facts.Value()
   @State var query = ""
 
   @Dependency(\.defaultDatabase) var database
@@ -38,10 +37,14 @@ struct DynamicQueryDemo: SwiftUICaseStudy {
         ForEach(facts.facts) { fact in
           Text(fact.body)
         }
-        .onDelete { indexSet in
+        .onDelete { indices in
           withErrorReporting {
             try database.write { db in
-              _ = try Fact.deleteAll(db, ids: indexSet.compactMap { facts.facts[$0].id })
+              let ids = indices.map { facts.facts[$0].id }
+              try Fact
+                .where { $0.id.in(ids) }
+                .delete()
+                .execute(db)
             }
           }
         }
@@ -50,7 +53,7 @@ struct DynamicQueryDemo: SwiftUICaseStudy {
     .searchable(text: $query)
     .task(id: query) {
       await withErrorReporting {
-        try await $facts.load(.fetch(Facts(query: query), animation: .default))
+        try await $facts.load(Facts(query: query), animation: .default)
       }
     }
     .task {
@@ -65,7 +68,8 @@ struct DynamicQueryDemo: SwiftUICaseStudy {
             as: UTF8.self
           )
           try await database.write { db in
-            _ = try Fact(body: fact).inserted(db)
+            try Fact.insert(Fact.Draft(body: fact))
+              .execute(db)
           }
         }
       } catch {}
@@ -80,35 +84,39 @@ struct DynamicQueryDemo: SwiftUICaseStudy {
       var totalCount = 0
     }
     func fetch(_ db: Database) throws -> Value {
-      let query = Fact.order(Column("id").desc).filter(Column("body").like("%\(query)%"))
+      let search =
+        Fact
+        .where { $0.body.contains(query) }
+        .order { $0.id.desc() }
       return try Value(
-        facts: query.fetchAll(db),
-        searchCount: query.fetchCount(db),
-        totalCount: Fact.fetchCount(db)
+        facts: search.fetchAll(db),
+        searchCount: search.fetchCount(db),
+        totalCount: Fact.all.fetchCount(db)
       )
     }
   }
-
 }
 
-private struct Fact: Codable, FetchableRecord, Identifiable, MutablePersistableRecord {
-  static let databaseTableName = "facts"
-  var id: Int64?
+@Table
+private struct Fact: Identifiable {
+  let id: Int
   var body: String
-  mutating func didInsert(_ inserted: InsertionSuccess) {
-    id = inserted.rowID
-  }
 }
 
 extension DatabaseWriter where Self == DatabaseQueue {
   static var dynamicQueryDatabase: Self {
     let databaseQueue = try! DatabaseQueue()
     var migrator = DatabaseMigrator()
     migrator.registerMigration("Create 'facts' table") { db in
-      try db.create(table: Fact.databaseTableName) { table in
-        table.autoIncrementedPrimaryKey("id")
-        table.column("body", .text).notNull()
-      }
+      try #sql(
+        """
+        CREATE TABLE "facts" (
+          "id" INTEGER PRIMARY KEY AUTOINCREMENT,
+          "body" TEXT NOT NULL
+        )
+        """
+      )
+      .execute(db)
     }
     try! migrator.migrate(databaseQueue)
     return databaseQueue

Examples/CaseStudies/ObservableModelDemo.swift

@@ -1,4 +1,3 @@
-import Dependencies
 import SharingGRDB
 import SwiftUI
 
@@ -7,7 +6,7 @@ struct ObservableModelDemo: SwiftUICaseStudy {
     This demonstrates how to use the `fetchAll` and `fetchOne` tools in an @Observable model. \
     In SwiftUI, the `@Query` macro only works when installed directly in a SwiftUI view, and \
     cannot be used outside of views.
-    
+
     The tools provided with this library work basically anywhere, including in `@Observable` \
     models and UIKit view controllers.
     """
@@ -47,10 +46,10 @@ struct ObservableModelDemo: SwiftUICaseStudy {
 @MainActor
 private class Model {
   @ObservationIgnored
-  @SharedReader(.fetchAll(sql: #"SELECT * FROM "facts" ORDER BY "id" DESC"#, animation: .default))
-  var facts: [Fact]
+  @FetchAll(Fact.order { $0.id.desc() }, animation: .default)
+  var facts
   @ObservationIgnored
-  @SharedReader(.fetchOne(sql: #"SELECT count(*) FROM "facts""#, animation: .default))
+  @FetchOne(Fact.count(), animation: .default)
   var factsCount = 0
   var number = 0
 
@@ -66,38 +65,45 @@ private class Model {
         as: UTF8.self
       )
       try await database.write { db in
-        _ = try Fact(body: fact).inserted(db)
+        try Fact.insert(Fact.Draft(body: fact))
+          .execute(db)
       }
     }
   }
 
   func deleteFact(indices: IndexSet) {
-    _ = withErrorReporting {
+    withErrorReporting {
       try database.write { db in
-        try Fact.deleteAll(db, ids: indices.compactMap { facts[$0].id })
+        let ids = indices.map { facts[$0].id }
+        try Fact
+          .where { $0.id.in(ids) }
+          .delete()
+          .execute(db)
       }
     }
   }
 }
 
-private struct Fact: Codable, FetchableRecord, Identifiable, MutablePersistableRecord {
-  static let databaseTableName = "facts"
-  var id: Int64?
+@Table
+private struct Fact: Identifiable {
+  let id: Int
   var body: String
-  mutating func didInsert(_ inserted: InsertionSuccess) {
-    id = inserted.rowID
-  }
 }
 
 extension DatabaseWriter where Self == DatabaseQueue {
   static var observableModelDatabase: Self {
     let databaseQueue = try! DatabaseQueue()
     var migrator = DatabaseMigrator()
     migrator.registerMigration("Create 'facts' table") { db in
-      try db.create(table: Fact.databaseTableName) { table in
-        table.autoIncrementedPrimaryKey("id")
-        table.column("body", .text).notNull()
-      }
+      try #sql(
+        """
+        CREATE TABLE "facts" (
+          "id" INTEGER PRIMARY KEY AUTOINCREMENT,
+          "body" TEXT NOT NULL
+        )
+        """
+      )
+      .execute(db)
     }
     try! migrator.migrate(databaseQueue)
     return databaseQueue

Examples/CaseStudies/SwiftDataTemplateDemo.swift

@@ -9,12 +9,12 @@ struct SwiftDataTemplateView: SwiftUICaseStudy {
   let caseStudyTitle = "SwiftData Template"
 
   @Dependency(\.defaultDatabase) private var database
-  @SharedReader(.fetch(Items(), animation: .default)) private var items
+  @FetchAll(Item.all, animation: .default) private var items
 
   var body: some View {
     NavigationStack {
       List {
-        ForEach(items, id: \.id) { item in
+        ForEach(items) { item in
           NavigationLink {
             Text(
               "Item at \(item.timestamp, format: Date.FormatStyle(date: .numeric, time: .standard))"
@@ -41,28 +41,24 @@ struct SwiftDataTemplateView: SwiftUICaseStudy {
   private func addItem() {
     withErrorReporting {
       try database.write { db in
-        _ = try Item(timestamp: Date()).inserted(db)
+        try Item.insert().execute(db)
       }
     }
   }
 
   private func deleteItems(offsets: IndexSet) {
     withErrorReporting {
       try database.write { db in
-        _ = try Item.deleteAll(db, keys: offsets.map { items[$0].id })
+        try Item.where { $0.id.in(offsets.map { items[$0].id }) }.delete().execute(db)
       }
     }
   }
-
-  private struct Items: FetchKeyRequest {
-    func fetch(_ db: Database) throws -> [Item] {
-      try Item.order(Column("timestamp").desc).fetchAll(db)
-    }
-  }
 }
 
-private struct Item: Codable, Hashable, FetchableRecord, MutablePersistableRecord {
-  var id: Int64?
+@Table
+private struct Item: Identifiable {
+  let id: Int
+  @Column(as: Date.ISO8601Representation.self)
   var timestamp: Date
 }
 
@@ -71,10 +67,15 @@ extension DatabaseWriter where Self == DatabaseQueue {
     let databaseQueue = try! DatabaseQueue()
     var migrator = DatabaseMigrator()
     migrator.registerMigration("Create items table") { db in
-      try db.create(table: Item.databaseTableName) { table in
-        table.autoIncrementedPrimaryKey("id")
-        table.column("timestamp", .datetime).notNull()
-      }
+      try #sql(
+        """
+        CREATE TABLE "items" (
+          "id" INTEGER PRIMARY KEY AUTOINCREMENT,
+          "timestamp" TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
+        )
+        """
+      )
+      .execute(db)
     }
     try! migrator.migrate(databaseQueue)
     return databaseQueue