scout-sqlite

Scout-sqlite (WIP)

This is still a WIP tool. I am Looking for your feedback in Feedback issue.

Currently tools like Drizzle ORM, Kysely don't support SQLite FTS index creation. Scout-sqlite aims to bridge that gap by helping create and manage FTS index creation.

Getting Started

Install the scout-sqlite cli using your favourite package manager

• npm install scout-sqlite -D
• pnpm add scout-sqlite -D
• yarn add scout-sqlite -D
• bun install scout-sqlite

Initialize an empty configuration file with npx scout init. This creates a sqlitefts5rc.json file in the current working directory.

[
  {
    "table": "YOUR TABLE HERE",
    "idColumn": "YOUR TABLE HERE",
    "columns": [
      "YOUR",
      "COLUMNS",
      "HERE"
    ]
  }
]

Replace place holder text with your own values then run npx scout apply to create the FTS5 indexes and management triggers.

Roadmap

• Support local SQLite db
• Handle updates of existing indexes and triggers