Graphorin API reference v0.7.0
Graphorin API reference / @graphorin/store-sqlite / / CreateSqliteStoreOptions
Interface: CreateSqliteStoreOptions
Defined in: packages/store-sqlite/src/index.ts:137
Options passed to createSqliteStore.
Stable
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
busyTimeoutMs? | readonly | number | W-067: busy-handler wait for a contended write lock before the operation fails with SqliteBusyError. Default 5000. | packages/store-sqlite/src/index.ts:166 |
cipherLoader? | readonly | () => Promise<BetterSqlite3Constructor> | Internal Optional cipher-driver loader override (test-only seam). See OpenConnectionOptions.cipherLoader. | packages/store-sqlite/src/index.ts:184 |
disableWalHardening? | readonly | boolean | If true, skip the WAL hardening pragmas (only for :memory:). | packages/store-sqlite/src/index.ts:161 |
driver? | readonly | BetterSqlite3Constructor | Override constructor - test-only escape hatch. | packages/store-sqlite/src/index.ts:157 |
embedderPolicy? | readonly | EmbedderPolicy | Default 'lock-on-first' (DEC-116). | packages/store-sqlite/src/index.ts:143 |
encryption? | readonly | EncryptionConfig | Default { enabled: false }. | packages/store-sqlite/src/index.ts:145 |
loadVecExtension? | readonly | (db) => void | Override the sqlite-vec loader - test-only escape hatch. | packages/store-sqlite/src/index.ts:159 |
mode? | readonly | SqliteStoreMode | Default 'lib'. | packages/store-sqlite/src/index.ts:141 |
path | readonly | string | SQLite path. Pass ':memory:' for a transient in-memory database. | packages/store-sqlite/src/index.ts:139 |
skipFtsIntegrityCheck? | readonly | boolean | If true, skip the open-time FTS integrity check (CS-10). 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:177 |
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:155 |
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:150 |
warn? | readonly | (message) => void | Sink for non-fatal startup warnings - currently the CS-10 FTS↔rowid integrity check. Defaults to console.warn. | packages/store-sqlite/src/index.ts:171 |