Class SqliteFts5

SQLite FTS5 full-text search implementation.

Uses FTS5 virtual tables with external-content support, porter/ascii tokenizers, and rowid-based joins to the content table.

Implements

Constructors

constructor

Methods

createIndex matchClause rankExpression rebuildCommand syncInsert sanitizeQuery joinClause

Constructors

constructor

Methods

createIndex

  • createIndex(config): string

  • Generate DDL to create the full-text search index.

    Parameters

    • config: {
          table: string;
          columns: string[];
          contentTable?: string;
          tokenizer?: string;
      }
      • table: string

        Name for the FTS index/virtual table.

      • columns: string[]

        Columns to index.

      • OptionalcontentTable?: string

        Source table (for external-content FTS5).

      • Optionaltokenizer?: string

        Tokenizer config (e.g. 'porter ascii').

    Returns string

matchClause

  • matchClause(indexName, queryPlaceholder): string

  • Generate a WHERE clause fragment for full-text matching. SQLite: memory_traces_fts MATCH ? Postgres: memory_traces._tsv @@ plainto_tsquery('english', $1)

    Parameters

    • indexName: string
    • queryPlaceholder: string

    Returns string

rankExpression

  • rankExpression(indexName, _queryPlaceholder?): string

  • Generate an ORDER BY rank expression. SQLite: memory_traces_fts.rank Postgres: ts_rank(memory_traces._tsv, plainto_tsquery('english', $1))

    Parameters

    • indexName: string
    • Optional_queryPlaceholder: string

    Returns string

rebuildCommand

  • rebuildCommand(indexName): string

  • Generate the rebuild/reindex command. SQLite: INSERT INTO fts_table(fts_table) VALUES('rebuild') Postgres: UPDATE content_table SET _tsv = to_tsvector('english', col1 || ' ' || col2)

    Parameters

    • indexName: string

    Returns string

syncInsert

  • syncInsert(indexName, rowIdExpr, columns): string

  • Generate an INSERT to sync external-content FTS after a row insert. SQLite: INSERT INTO fts_table (rowid, col1, col2) VALUES (expr, ?, ?) Postgres: UPDATE content_table SET _tsv = to_tsvector(...) WHERE ...

    Parameters

    • indexName: string
    • rowIdExpr: string
    • columns: string[]

    Returns string

sanitizeQuery

  • sanitizeQuery(input): string

  • Sanitize natural-language input into a safe search query. SQLite: wraps words in quotes, strips FTS5 operators. Postgres: pass-through (plainto_tsquery handles it).

    Parameters

    • input: string

    Returns string

joinClause

  • joinClause(contentTable, contentAlias, ftsAlias, indexName): string

  • Generate a SELECT joining the FTS index to the content table. This handles the structural difference between FTS5 (separate virtual table joined via rowid) and Postgres (tsvector column on the content table itself).

    Parameters

    • contentTable: string

      The base table (e.g. 'memory_traces').

    • contentAlias: string

      Alias for the content table (e.g. 't').

    • ftsAlias: string

      Alias for the FTS table/column (e.g. 'fts').

    • indexName: string

      FTS index/virtual table name.

    Returns string

    FROM/JOIN clause fragment.

Settings

Member Visibility

On This Page

Constructors
Methods