Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/store-sqlite / / CreateSqliteStoreOptions

Interface: CreateSqliteStoreOptions

Defined in: packages/store-sqlite/src/index.ts:113

Options passed to createSqliteStore.

Stable

Properties

PropertyModifierTypeDescriptionDefined in
cipherLoader?readonly() => Promise<BetterSqlite3Constructor>Internal Optional cipher-driver loader override (test-only seam). See import('./connection.js').OpenConnectionOptions.cipherLoader.packages/store-sqlite/src/index.ts:144
disableWalHardening?readonlybooleanIf true, skip the WAL hardening pragmas (only for :memory:).packages/store-sqlite/src/index.ts:137
driver?readonlyBetterSqlite3ConstructorOverride constructor — test-only escape hatch.packages/store-sqlite/src/index.ts:133
embedderPolicy?readonlyEmbedderPolicyDefault 'lock-on-first' (DEC-116).packages/store-sqlite/src/index.ts:119
encryption?readonlyEncryptionConfigDefault { enabled: false }.packages/store-sqlite/src/index.ts:121
loadVecExtension?readonly(db) => voidOverride the sqlite-vec loader — test-only escape hatch.packages/store-sqlite/src/index.ts:135
mode?readonlySqliteStoreModeDefault 'lib'.packages/store-sqlite/src/index.ts:117
pathreadonlystringSQLite path. Pass ':memory:' for a transient in-memory database.packages/store-sqlite/src/index.ts:115
skipSqliteVec?readonlybooleanIf 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:131
walCheckpointIntervalMs?readonlynumberPeriodic checkpoint cadence. Default 300_000 (5 min) in server mode; off in library mode unless explicitly set.packages/store-sqlite/src/index.ts:126