pg-smart-search
API Reference

CLI Commands

Command line interface reference for the pg-smart-search migration and setup tool.

CLI Commands

pg-smart-search init

Initializes the database for pg-smart-search by creating required indices and generated columns.

npx pg-smart-search init [options]

Options

FlagDescriptionDefault
--applyApply migrations directly to the database without prompting.false
--outputOutput the generated SQL without executing it.false
--url <string>Database connection string.Prompted / Env var

pg-smart-search bench

Benchmarks the search performance on your actual dataset.

npx pg-smart-search bench

Runs a series of standard search queries against your database and reports average cold and hot latencies.