Skip to content

API reference

Generated from each package’s Go doc comments — the same content as pkg.go.dev, rendered here alongside the rest of the docs.

PackageSummary
ftsPackage fts is a typed, generics-aware wrapper around SQLite’s FTS5 full-text-search virtual table, layered on top of gosqlite.org.
fts/gormPackage ftsgorm provides a tag-driven bridge between gorm models and SQLite FTS5 search indexes.
fusionPackage fusion implements rank-fusion helpers for combining multiple ranked result sets — most commonly a vec.KNN result and an fts.Search result — into a single merged ranking.
gormPackage sqlite provides a gorm Dialector backed by the CGo-free gosqlite.org driver.
pcachePackage pcache installs an application-controlled SQLite page cache — the heap SQLite uses to hold database pages between reads and writes.
sqlitexPackage sqlitex provides ergonomic helpers over a database/sql SQLite database: deferred savepoints, transaction wrappers, multi-statement scripts, a row-callback query runner, single-row and multi-row scalar reads, and an embed.FS schema-migration runner.
vecPackage vec adds first-class vector-search support to gosqlite.org by bundling the sqlite-vec extension and a small Go API layered on top of it.
vec/gormPackage vecgorm provides a tag-driven bridge between gorm models and sqlite-vec virtual-table sidecars.
vfsPackage vfs lets you back a SQLite database with storage you control, in pure Go.
vfs/cksmPackage cksm provides a corruption-detection VFS for SQLite.
vfs/cryptoPackage crypto provides a pure-Go encryption-at-rest VFS for SQLite.
vfs/memdbPackage memdb implements a plain in-memory SQLite VFS — pages live in a Go-side map per database name, reads and writes hit it directly, and there is no journal, no WAL, and no on-disk representation.
vfs/mvccPackage mvcc implements an in-memory SQLite VFS with multi-version concurrency control.