wip

Author: stephencelis

Sources/StructuredQueriesCore/Operators.swift

@@ -730,20 +730,6 @@ extension QueryExpression where QueryValue == String {
     LikeOperator(string: self, pattern: pattern, escape: escape)
   }
 
-  /// A predicate expression from this string expression matched against another _via_ the `MATCH`
-  /// operator.
-  ///
-  /// ```swift
-  /// Reminder.where { $0.title.match("get") }
-  /// // SELECT … FROM "reminders" WHERE ("reminders"."title" MATCH 'get')
-  /// ```
-  ///
-  /// - Parameter pattern: A string expression describing the `MATCH` pattern.
-  /// - Returns: A predicate expression.
-  public func match(_ pattern: QueryValue) -> some QueryExpression<Bool> {
-    BinaryOperator(lhs: self, operator: "MATCH", rhs: pattern)
-  }
-
   /// A predicate expression from this string expression matched against another _via_ the `LIKE`
   /// operator given a prefix.
   ///

Sources/StructuredQueriesCore/SQLite/FTS5.swift

@@ -1,6 +1,18 @@
+/// A virtual table using the FTS5 extension.
+///
+/// Apply this protocol to a `@Table` declaration to introduce FTS5 helpers.
 public protocol FTS5: Table {}
-
 extension TableDefinition where QueryValue: FTS5 {
+  @available(*, deprecated, message: "Virtual tables are not 'rowid' tables")
+  public var rowid: some QueryExpression<Int> {
+    SQLQueryExpression(
+      """
+      \(QueryValue.self)."rowid"
+      """
+    )
+  }
+
+  /// An expression representing the search result's rank.
   public var rank: some QueryExpression<Double?> {
     SQLQueryExpression(
       """
@@ -9,6 +21,15 @@ extension TableDefinition where QueryValue: FTS5 {
     )
   }
 
+  /// A predicate expression from this table matched against another _via_ the `MATCH` operator.
+  ///
+  /// ```swift
+  /// ReminderText.where { $0.match("get") }
+  /// // SELECT … FROM "reminderTexts" WHERE ("reminderTexts" MATCH 'get')
+  /// ```
+  ///
+  /// - Parameter pattern: A string expression describing the `MATCH` pattern.
+  /// - Returns: A predicate expression.
   public func match(_ pattern: some QueryExpression<String>) -> some QueryExpression<Bool> {
     SQLQueryExpression(
       """
@@ -19,6 +40,12 @@ extension TableDefinition where QueryValue: FTS5 {
 }
 
 extension TableColumnExpression where Root: FTS5 {
+  /// A string expression highlighting matches in this column using the given delimiters.
+  ///
+  /// - Parameters:
+  ///   - open: An opening delimiter denoting the beginning of a match, _e.g._ `"<b>"`.
+  ///   - close: A closing delimiter denoting the end of a match, _e.g._, `"</b>"`.
+  /// - Returns: A string expression highlighting matches in this column.
   public func highlight(
     _ open: String,
     _ close: String
@@ -37,4 +64,17 @@ extension TableColumnExpression where Root: FTS5 {
       """
     )
   }
+
+  /// A predicate expression from this column matched against another _via_ the `MATCH` operator.
+  ///
+  /// ```swift
+  /// ReminderText.where { $0.title.match("get") }
+  /// // SELECT … FROM "reminderTexts" WHERE ("reminderTexts"."title" MATCH 'get')
+  /// ```
+  ///
+  /// - Parameter pattern: A string expression describing the `MATCH` pattern.
+  /// - Returns: A predicate expression.
+  public func match(_ pattern: some QueryExpression<String>) -> some QueryExpression<Bool> {
+    BinaryOperator(lhs: self, operator: "MATCH", rhs: pattern)
+  }
 }