Graphorin API reference v0.15.1
Graphorin API reference / @graphorin/store-sqlite / / CreateSqliteStoreOptions
Interface: CreateSqliteStoreOptions
Defined in: packages/store-sqlite/src/index.ts:161
Stable
Options passed to createSqliteStore.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
busyTimeoutMs? | readonly | number | Busy-handler wait for a contended write lock before the operation fails with SqliteBusyError. Default 5000. | packages/store-sqlite/src/index.ts:198 |
cipherLoader? | readonly | () => Promise<BetterSqlite3Constructor> | Internal Optional cipher-driver loader override (test-only seam). See OpenConnectionOptions.cipherLoader. | packages/store-sqlite/src/index.ts:216 |
disableWalHardening? | readonly | boolean | If true, skip the WAL hardening pragmas (only for :memory:). | packages/store-sqlite/src/index.ts:193 |
driver? | readonly | BetterSqlite3Constructor | Override constructor - test-only escape hatch. | packages/store-sqlite/src/index.ts:189 |
embedderPolicy? | readonly | EmbedderPolicy | Default 'lock-on-first' (DEC-116). | packages/store-sqlite/src/index.ts:167 |
encryption? | readonly | EncryptionConfig | Default { enabled: false }. | packages/store-sqlite/src/index.ts:169 |
loadVecExtension? | readonly | (db) => void | Override the sqlite-vec loader - test-only escape hatch. | packages/store-sqlite/src/index.ts:191 |
mode? | readonly | SqliteStoreMode | Default 'lib'. | packages/store-sqlite/src/index.ts:165 |
onMissingSqliteVec? | readonly | "linear-fallback" | "fail" | Policy when the sqlite-vec peer is missing/broken. 'fail' (default) throws SqliteVecMissingError; 'linear-fallback' serves vectors from plain sidecar tables with an in-process batched cosine scan. See OpenConnectionOptions.onMissingSqliteVec. | packages/store-sqlite/src/index.ts:187 |
path | readonly | string | SQLite path. Pass ':memory:' for a transient in-memory database. | packages/store-sqlite/src/index.ts:163 |
skipFtsIntegrityCheck? | readonly | boolean | If true, skip the open-time FTS integrity check. The check is a cheap orphan-row scan; disable it only for very large stores where a per-open scan is undesirable. | packages/store-sqlite/src/index.ts:209 |
skipSqliteVec? | readonly | boolean | If true, do not load the sqlite-vec peer at open time. Useful for tests that exercise migrations without the native build. | packages/store-sqlite/src/index.ts:179 |
walCheckpointIntervalMs? | readonly | number | Periodic checkpoint cadence. Default 300_000 (5 min) in server mode; off in library mode unless explicitly set. | packages/store-sqlite/src/index.ts:174 |
warn? | readonly | (message) => void | Sink for non-fatal startup warnings - currently the FTS↔rowid integrity check. Defaults to console.warn. | packages/store-sqlite/src/index.ts:203 |