Merge remote-tracking branch 'origin/main' into agg

Author: stephencelis

Sources/StructuredQueriesCore/Documentation.docc/Articles/DefiningYourSchema.md

@@ -51,6 +51,10 @@ To define a Swift data type that represents this table, one can use the `@Table`
 }
 ```
 
+> Note: If your project is using [default main actor isolation] then you further need to annotate
+> your struct as `nonisolated`.
+[default main actor isolation]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0466-control-default-actor-isolation.md
+
 Note that the struct's field names match the column tables of the table exactly. In order to support
 property names that differ from the columns names, you can use the `@Column` macro. See the section
 below, <doc:DefiningYourSchema#Customizing-a-table>,  for more information on how to customize your

Sources/StructuredQueriesCore/Documentation.docc/Articles/QueryCookbook.md

@@ -50,6 +50,10 @@ extension Reminder {
 }
 ```
 
+> Note: If your project is using [default main actor isolation] then you further need to annotate
+> your extension as `nonisolated`, or define the helpers directly in the declaration of the struct.
+[default main actor isolation]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0466-control-default-actor-isolation.md
+
 Then these helpers can be used when composing together a larger, more complex query. For example,
 we can select all non-deleted lists with the count of all non-deleted reminders in each list like
 so:
@@ -131,6 +135,10 @@ extension Reminder.TableColumns {
 }
 ```
 
+> Note: If your project is using [default main actor isolation] then you further need to annotate
+> your extension as `nonisolated`.
+[default main actor isolation]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0466-control-default-actor-isolation.md
+
 Then you can use these helpers when building a query. For example, you can use
 ``PrimaryKeyedTableDefinition/count(distinct:filter:)`` to count the number of past due, current and
 scheduled reminders in one single query like so:

Sources/StructuredQueriesCore/Never.swift

@@ -25,3 +25,5 @@ extension Never: Table {
 
   private struct NotDecodable: Error {}
 }
+
+extension Never: _Selection {}

Sources/StructuredQueriesCore/Optional.swift

@@ -183,6 +183,8 @@ extension Optional: Table, PartialSelectStatement, Statement where Wrapped: Tabl
   public typealias Selection = Wrapped.Selection?
 }
 
+extension Optional: _Selection where Wrapped: _Selection {}
+
 extension Optional: PrimaryKeyedTable where Wrapped: PrimaryKeyedTable {
   public typealias Draft = Wrapped.Draft?
 }

Sources/StructuredQueriesCore/Statement.swift

@@ -1,5 +1,5 @@
 /// A type that represents a full SQL query.
-public protocol Statement<QueryValue>: QueryExpression, Hashable {
+public protocol Statement<QueryValue>: QueryExpression {
   /// A type representing the table being queried.
   associatedtype From: Table
 
@@ -15,13 +15,3 @@ extension Statement {
     "(\(.newline)\(query.indented())\(.newline))"
   }
 }
-
-extension Statement {
-  public static func == (lhs: Self, rhs: Self) -> Bool {
-    lhs.query == rhs.query
-  }
-
-  public func hash(into hasher: inout Hasher) {
-    hasher.combine(query)
-  }
-}

Sources/StructuredQueriesCore/TableAlias.swift

@@ -183,6 +183,8 @@ public struct TableAlias<
   }
 }
 
+extension TableAlias: _Selection where Base: _Selection {}
+
 extension TableAlias: PrimaryKeyedTable where Base: PrimaryKeyedTable {
   public typealias Draft = TableAlias<Base.Draft, Name>
 }

Sources/StructuredQueriesSQLiteCore/Documentation.docc/Articles/CustomFunctions.md

@@ -18,6 +18,10 @@ func exclaim(_ string: String) -> String {
 }
 ```
 
+> Note: If your project is using [default main actor isolation] then you further need to annotate
+> your function as `nonisolated`.
+[default main actor isolation]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0466-control-default-actor-isolation.md
+
 And will be immediately callable in a query by prefixing the function with `$`:
 
 ```swift

Sources/StructuredQueriesSQLiteCore/Documentation.docc/Articles/Triggers.md

@@ -45,13 +45,13 @@ refreshed with the current time immediately.
 
 This pattern of updating a timestamp when a row changes is so common that the library comes with
 a specialized tool just for that kind of trigger,
-``StructuredQueriesCore/Table/createTemporaryTrigger(_:ifNotExists:afterUpdateTouch:fileID:line:column:)``:
+``TemporaryTrigger/Operation/update(touch:when:)``:
 
 @Row {
   @Column {
     ```swift
     Reminder.createTemporaryTrigger(
-      afterUpdateTouch: {
+      after: .update: {
         $0.updatedAt = datetime('subsec')
       }
     )
@@ -72,14 +72,14 @@ a specialized tool just for that kind of trigger,
 
 And further, the pattern of specifically updating a _timestamp_ column is so common that the library
 comes with another specialized too just for that kind of trigger,
-``StructuredQueriesCore/Table/createTemporaryTrigger(_:ifNotExists:afterUpdateTouch:fileID:line:column:)``:
+``TemporaryTrigger/Operation/update(touch:when:)``:
 
 
 @Row {
   @Column {
     ```swift
     Reminder.createTemporaryTrigger(
-      afterUpdateTouch: \.updatedAt
+      after: .update(touch: \.updatedAt)
     )
     ```
   }
@@ -195,11 +195,11 @@ reminder is inserted into the database with the following trigger:
 - ``StructuredQueriesCore/Table/createTemporaryTrigger(_:ifNotExists:before:fileID:line:column:)``
 - ``StructuredQueriesCore/Table/createTemporaryTrigger(_:ifNotExists:insteadOf:fileID:line:column:)``
 
-### Touching records
-
-- ``StructuredQueriesCore/Table/createTemporaryTrigger(_:ifNotExists:afterInsertTouch:fileID:line:column:)``
-- ``StructuredQueriesCore/Table/createTemporaryTrigger(_:ifNotExists:afterUpdateTouch:fileID:line:column:)``
-
 ### Triggers
 
 - ``TemporaryTrigger``
+
+### Deprecations
+
+- ``StructuredQueriesCore/Table/createTemporaryTrigger(_:ifNotExists:afterInsertTouch:fileID:line:column:)``
+- ``StructuredQueriesCore/Table/createTemporaryTrigger(_:ifNotExists:afterUpdateTouch:fileID:line:column:)``

Sources/StructuredQueriesSQLiteCore/Internal/Deprecations.swift

@@ -1,11 +1,123 @@
 import Foundation
 import StructuredQueriesCore
 
+// NB: Deprecated after 0.22.2:
+
+extension Table {
+  @available(
+    *,
+    deprecated,
+    message: "Prefer 'createTemporaryTrigger(after: .update(touch:))', instead"
+  )
+  public static func createTemporaryTrigger(
+    _ name: String? = nil,
+    ifNotExists: Bool = false,
+    afterUpdateTouch updates: (inout Updates<Self>) -> Void,
+    fileID: StaticString = #fileID,
+    line: UInt = #line,
+    column: UInt = #column
+  ) -> TemporaryTrigger<Self> {
+    Self.createTemporaryTrigger(
+      name,
+      ifNotExists: ifNotExists,
+      after: .update { _, new in
+        Self
+          .where { $0.rowid.eq(new.rowid) }
+          .update { updates(&$0) }
+      },
+      fileID: fileID,
+      line: line,
+      column: column
+    )
+  }
+
+  @available(
+    *,
+    deprecated,
+    message: "Prefer 'createTemporaryTrigger(after: .update(touch:))', instead"
+  )
+  public static func createTemporaryTrigger<D: _OptionalPromotable<Date?>>(
+    _ name: String? = nil,
+    ifNotExists: Bool = false,
+    afterUpdateTouch dateColumn: KeyPath<TableColumns, TableColumn<Self, D>>,
+    date dateFunction: any QueryExpression<D> = SQLQueryExpression<D>("datetime('subsec')"),
+    fileID: StaticString = #fileID,
+    line: UInt = #line,
+    column: UInt = #column
+  ) -> TemporaryTrigger<Self> {
+    Self.createTemporaryTrigger(
+      name,
+      ifNotExists: ifNotExists,
+      afterUpdateTouch: {
+        $0[dynamicMember: dateColumn] = dateFunction
+      },
+      fileID: fileID,
+      line: line,
+      column: column
+    )
+  }
+
+  @available(
+    *,
+    deprecated,
+    message: "Prefer 'createTemporaryTrigger(after: .insert(touch:))', instead"
+  )
+  public static func createTemporaryTrigger(
+    _ name: String? = nil,
+    ifNotExists: Bool = false,
+    afterInsertTouch updates: (inout Updates<Self>) -> Void,
+    fileID: StaticString = #fileID,
+    line: UInt = #line,
+    column: UInt = #column
+  ) -> TemporaryTrigger<Self> {
+    Self.createTemporaryTrigger(
+      name,
+      ifNotExists: ifNotExists,
+      after: .insert { new in
+        Self
+          .where { $0.rowid.eq(new.rowid) }
+          .update { updates(&$0) }
+      },
+      fileID: fileID,
+      line: line,
+      column: column
+    )
+  }
+
+  @available(
+    *,
+    deprecated,
+    message: "Prefer 'createTemporaryTrigger(after: .insert(touch:))', instead"
+  )
+  public static func createTemporaryTrigger<D: _OptionalPromotable<Date?>>(
+    _ name: String? = nil,
+    ifNotExists: Bool = false,
+    afterInsertTouch dateColumn: KeyPath<TableColumns, TableColumn<Self, D>>,
+    date dateFunction: any QueryExpression<D> = SQLQueryExpression<D>("datetime('subsec')"),
+    fileID: StaticString = #fileID,
+    line: UInt = #line,
+    column: UInt = #column
+  ) -> TemporaryTrigger<Self> {
+    Self.createTemporaryTrigger(
+      name,
+      ifNotExists: ifNotExists,
+      afterInsertTouch: {
+        $0[dynamicMember: dateColumn] = dateFunction
+      },
+      fileID: fileID,
+      line: line,
+      column: column
+    )
+  }
+}
+
 // NB: Deprecated after 0.5.1:
 
 extension Table {
   @available(
-    *, deprecated, message: "Use a trailing closure, instead: 'Table.insert { row }'"
+    *,
+    deprecated,
+    message: "Use a trailing closure, instead: 'Table.insert { row }'"
   )
   public static func insert(
     or conflictResolution: ConflictResolution,
@@ -16,7 +128,9 @@ extension Table {
   }
 
   @available(
-    *, deprecated, message: "Use a trailing closure, instead: 'Table.insert { rows }'"
+    *,
+    deprecated,
+    message: "Use a trailing closure, instead: 'Table.insert { rows }'"
   )
   public static func insert(
     or conflictResolution: ConflictResolution,
@@ -49,7 +163,10 @@ extension Table {
 
   @available(*, deprecated, renamed: "insert(or:_:select:onConflictDoUpdate:)")
   public static func insert<
-    V1, each V2, From, Joins
+    V1,
+    each V2,
+    From,
+    Joins
   >(
     or conflictResolution: ConflictResolution,
     _ columns: (TableColumns) -> (TableColumn<Self, V1>, repeat TableColumn<Self, each V2>),
@@ -62,7 +179,9 @@ extension Table {
 
 extension PrimaryKeyedTable {
   @available(
-    *, deprecated, message: "Use a trailing closure, instead: 'Table.insert { draft }'"
+    *,
+    deprecated,
+    message: "Use a trailing closure, instead: 'Table.insert { draft }'"
   )
   public static func insert(
     or conflictResolution: ConflictResolution,
@@ -73,7 +192,9 @@ extension PrimaryKeyedTable {
   }
 
   @available(
-    *, deprecated, message: "Use a trailing closure, instead: 'Table.insert { drafts }'"
+    *,
+    deprecated,
+    message: "Use a trailing closure, instead: 'Table.insert { drafts }'"
   )
   public static func insert(
     or conflictResolution: ConflictResolution,
@@ -84,7 +205,9 @@ extension PrimaryKeyedTable {
   }
 
   @available(
-    *, deprecated, message: "Use a trailing closure, instead: 'Table.upsert { draft }'"
+    *,
+    deprecated,
+    message: "Use a trailing closure, instead: 'Table.upsert { draft }'"
   )
   public static func upsert(
     or conflictResolution: ConflictResolution,