Expand description
FTS5 full-text search extension (§14.2).
Provides: tokenizer API (unicode61, ascii, porter, trigram), inverted index, boolean query parsing (implicit AND, OR, NOT binary-only, phrase, prefix, NEAR, column filter, caret), BM25 ranking, FTS5 virtual table with content modes, and secure-delete / contentless-delete configuration.
Structs§
- Ascii
Tokenizer - ASCII tokenizer: like unicode61 but only ASCII alphanumeric characters.
- Fts5
Config - Fts5
Cursor - FTS5 cursor for scanning query results.
- Fts5
Highlight Func - highlight(text, query, open, close) — highlight FTS5 query terms in text.
- Fts5
Query Token - A token in an FTS5 query.
- Fts5
Snippet Func - snippet(text, query, open, close, ellipsis, max_tokens) — derive a highlighted snippet from text using FTS5 query terms.
- Fts5
Source IdFunc - fts5_source_id() — returns the FTS5 extension version string.
- Fts5
Table - FTS5 virtual table: full-text search index.
- Fts5
Token - A single token produced by an FTS5 tokenizer.
- Inverted
Index - In-memory inverted index for FTS5.
- Porter
Tokenizer - Porter stemmer tokenizer: wraps another tokenizer and applies Porter stemming to each term.
- Posting
- Trigram
Tokenizer - Trigram tokenizer: generates all 3-character substrings of the input.
- Unicode61
Tokenizer - Unicode61 tokenizer: splits on non-alphanumeric characters, lowercases.
Enums§
- Content
Mode - Delete
Action - Detail
Mode - Fts5
Expr - A parsed FTS5 query expression tree.
- Fts5
Query Error - FTS5 query validation errors.
- Fts5
Query Token Kind - Token kinds in an FTS5 query.
Traits§
- Fts5
Tokenizer - Trait for FTS5 tokenizers.
Functions§
- bm25_
score - Compute BM25 score for a document against a set of query terms.
- build_
expr - Build an expression tree from parsed FTS5 query tokens.
- create_
tokenizer - Create a tokenizer by name with optional arguments.
- evaluate_
expr - Evaluate an FTS5 expression against the inverted index, returning matching document IDs.
- extension_
name - highlight
- Generate a highlighted version of text with matching terms wrapped in markers.
- parse_
fts5_ query - Parse an FTS5 query string into tokens.
- register_
fts5_ scalars - Register FTS5 scalar functions into a
FunctionRegistry. - snippet
- Generate a snippet of text around matching terms.