Graphorin API reference v0.15.1

---

Graphorin API reference / @graphorin/store-sqlite / connection / BetterSqlite3Database

Interface: BetterSqlite3Database

Defined in: packages/store-sqlite/src/driver-types.ts:21

Internal

Subset of the better-sqlite3 Database surface used by the store. Declared structurally so the package can defer the peer dependency load to runtime and keep the module load free of side effects.

Properties

Property	Modifier	Type	Defined in
inTransaction	readonly	boolean	packages/store-sqlite/src/driver-types.ts:42
open	readonly	boolean	packages/store-sqlite/src/driver-types.ts:41

Methods

backup()

backup(destinationPath): Promise<unknown>;

Defined in: packages/store-sqlite/src/driver-types.ts:38

Online page-level backup. Consistent under a live writer and preserves rowids (so FTS5 external-content mappings survive - unlike VACUUM INTO).

Parameters

Parameter	Type
destinationPath	string

Returns

Promise<unknown>

---

close()

close(): void;

Defined in: packages/store-sqlite/src/driver-types.ts:39

Returns

void

---

exec()

exec(query): void;

Defined in: packages/store-sqlite/src/driver-types.ts:23

Parameters

Parameter	Type
query	string

Returns

void

---

loadExtension()

loadExtension(path): void;

Defined in: packages/store-sqlite/src/driver-types.ts:40

Parameters

Parameter	Type
path	string

Returns

void

---

pragma()

pragma(query, options?): unknown;

Defined in: packages/store-sqlite/src/driver-types.ts:22

Parameters

Parameter	Type
query	string
options?	{ simple?: boolean; }
options.simple?	boolean

Returns

unknown

---

prepare()

prepare(query): BetterSqlite3Statement;

Defined in: packages/store-sqlite/src/driver-types.ts:24

Parameters

Parameter	Type
query	string

Returns

BetterSqlite3Statement

---

transaction()

transaction<T>(fn): T & {
  deferred: T;
  exclusive: T;
  immediate: T;
};

Defined in: packages/store-sqlite/src/driver-types.ts:30

The returned wrapper also carries the .deferred / .immediate / .exclusive variants (the store uses .immediate for every write transaction).

Type Parameters

Type Parameter
T extends (...args) => unknown

Parameters

Parameter	Type
fn	T

Returns

T & { deferred: T; exclusive: T; immediate: T; }