Package Exports

scout-sqlite
scout-sqlite/dist/cli/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (scout-sqlite) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Scout-sqlite (WIP)

[!NOTE] 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.

// sqlitefts5rc.json
[
  {
    "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