Graphorin API reference v0.4.0

---

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

Interface: SqliteConnection

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

The runtime contract every higher-level store interacts with. The concrete adapter is built by openConnection and wraps either better-sqlite3 (default) or better-sqlite3-multiple-ciphers (encryption-at-rest opt-in).

Stable

Properties

Property	Modifier	Type	Description	Defined in
encrypted	readonly	boolean	Whether the connection is encryption-enabled.	packages/store-sqlite/src/connection.ts:28
inMemory	readonly	boolean	Whether the connection wraps a :memory: database.	packages/store-sqlite/src/connection.ts:30
path	readonly	string	Path to the underlying database file (':memory:' for in-memory).	packages/store-sqlite/src/connection.ts:26

Methods

all()

all<T>(query, params?): T[];

Defined in: packages/store-sqlite/src/connection.ts:36

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
query	string
params?	readonly unknown[]

Returns

T[]

---

close()

close(): void;

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

Returns

void

---

exec()

exec(query): void;

Defined in: packages/store-sqlite/src/connection.ts:32

Parameters

Parameter	Type
query	string

Returns

void

---

execMany()

execMany(sql): void;

Defined in: packages/store-sqlite/src/connection.ts:33

Parameters

Parameter	Type
sql	string

Returns

void

---

get()

get<T>(query, params?): T | undefined;

Defined in: packages/store-sqlite/src/connection.ts:35

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
query	string
params?	readonly unknown[]

Returns

T | undefined

---

pragma()

pragma(query, options?): unknown;

Defined in: packages/store-sqlite/src/connection.ts:31

Parameters

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

Returns

unknown

---

prepare()

prepare(query): BetterSqlite3Statement;

Defined in: packages/store-sqlite/src/connection.ts:37

Parameters

Parameter	Type
query	string

Returns

BetterSqlite3Statement

---

raw()

raw(): BetterSqlite3Database;

Defined in: packages/store-sqlite/src/connection.ts:41

Returns the underlying better-sqlite3 handle. Escape hatch only.

Returns

BetterSqlite3Database

---

run()

run(query, params?): {
  changes: number;
};

Defined in: packages/store-sqlite/src/connection.ts:34

Parameters

Parameter	Type
query	string
params?	readonly unknown[]

Returns

{
  changes: number;
}

Name	Type	Defined in
changes	number	packages/store-sqlite/src/connection.ts:34

---

transaction()

transaction<T>(fn): T;

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

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
fn	() => T

Returns

T