Skip to content

Improve FTS docs #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 21, 2025
Merged

Improve FTS docs #140

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions Sources/StructuredQueriesCore/SQLite/FTS5.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ import IssueReporting

/// A virtual table using the FTS5 extension.
///
/// Apply this protocol to a `@Table` declaration to introduce FTS5 helpers.
/// Apply this protocol to a `@Table` declaration to introduce [FTS5] helpers.
///
/// [FTS5]: https://www.sqlite.org/fts5.html
public protocol FTS5: Table {}

extension TableDefinition where QueryValue: FTS5 {
Expand All @@ -13,6 +15,16 @@ extension TableDefinition where QueryValue: FTS5 {
/// // SELECT … FROM "reminderTexts" WHERE ("reminderTexts" MATCH 'get')
/// ```
///
/// > Important: Avoid passing a string entered by the user directly to this operator. FTS5
/// > queries have a distinct [syntax] that can specify particular columns and refine a search in
/// > various ways. If FTS5 is given a query with invalid syntax, it can even throw SQL errors at
/// > runtime.
/// >
/// > Instead, consider transforming the user's input into a query by quoting, prefixing, and/or
/// > combining inputs from your UI into a valid query before handing it off to SQLite.
///
/// [syntax]: https://www.sqlite.org/fts5.html#full_text_query_syntax
///
/// - Parameter pattern: A string expression describing the `MATCH` pattern.
/// - Returns: A predicate expression.
public func match(_ pattern: some StringProtocol) -> some QueryExpression<Bool> {
Expand Down Expand Up @@ -60,7 +72,7 @@ extension TableColumnExpression where Root: FTS5 {
///
/// ```swift
/// ReminderText.where { $0.title.match("get") }
/// // SELECT … FROM "reminderTexts" WHERE ("reminderTexts"."title" MATCH 'get')
/// // SELECT … FROM "reminderTexts" WHERE ("reminderTexts" MATCH 'title:\"get\"')
/// ```
///
/// - Parameter pattern: A string expression describing the `MATCH` pattern.
Expand Down