SqliteDbWrapper

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:36

This class is mostly adding result caching around a SqliteDb which is used to speed up SQLite queries when used through the reactivity graph.

Implements

• SqliteDb

Constructors

new SqliteDbWrapper()

new SqliteDbWrapper(__namedParameters): SqliteDbWrapper

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:48

Parameters

__namedParameters

db

SqliteDb

otel

{ rootSpanContext: Context; tracer: Tracer; }

otel.rootSpanContext

Context

otel.tracer

Tracer

Returns

SqliteDbWrapper

Properties

_tag

_tag: "SqliteDb"

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:37

Implementation of

SqliteDb._tag

---

debugInfo

debugInfo: object

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:46

events

events: BoundArray<readonly [string, any]>

queryFrameCount

queryFrameCount: number

queryFrameDuration

queryFrameDuration: number

slowQueries

slowQueries: BoundArray<{ bindValues: any; durationMs: number; queriedTables: ReadonlySet<string>; queryStr: string; rowsCount: undefined | number; startTimePerfNow: number; }>

---

metadata

metadata: any

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:70

Implementation of

SqliteDb.metadata

Methods

close()

close(): void

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:77

Returns

void

Implementation of

SqliteDb.close

---

destroy()

destroy(): void

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:80

Returns

void

Implementation of

SqliteDb.destroy

---

execute()

execute(queryStr, bindValues?, options?): object

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:160

Parameters

queryStr

string

bindValues?

PreparedBindValues

options?

hasNoEffects?

boolean

onRowsChanged?

(rowsChanged) => void

otelContext?

Context

writeTables?

ReadonlySet<string>

Returns

object

durationMs

durationMs: number

Implementation of

SqliteDb.execute

---

export()

export(): Uint8Array<ArrayBufferLike>

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:295

Returns

Uint8Array<ArrayBufferLike>

Implementation of

SqliteDb.export

---

getTablesUsed()

getTablesUsed(query): Set<string>

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:132

Parameters

query

string

Returns

Set<string>

---

import()

import(data): void

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:74

Parameters

data

Uint8Array<ArrayBufferLike> | SqliteDb<any, any>

Returns

void

Implementation of

SqliteDb.import

---

makeChangeset()

makeChangeset(data): SqliteDbChangeset

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:86

Parameters

data

Uint8Array

Returns

SqliteDbChangeset

Implementation of

SqliteDb.makeChangeset

---

prepare()

prepare(queryStr): PreparedStatement

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:71

Parameters

queryStr

string

Returns

PreparedStatement

Implementation of

SqliteDb.prepare

---

rollback()

rollback(changeset): void

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:127

Parameters

changeset

Uint8Array

Returns

void

---

select()

select<T>(queryStr, bindValues?, options?): readonly T[]

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:224

Type Parameters

• T = any

Parameters

queryStr

string

bindValues?

PreparedBindValues

options?

otelContext?

Context

queriedTables?

ReadonlySet<string>

skipCache?

boolean

Returns

readonly T[]

Implementation of

SqliteDb.select

---

session()

session(): SqliteDbSession

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:83

Returns

SqliteDbSession

Implementation of

SqliteDb.session

---

txn()

txn<TRes>(callback): TRes

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:90

Type Parameters

• TRes

Parameters

callback

() => TRes

Returns

TRes

---

withChangeset()

withChangeset<TRes>(callback): object

Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:111

Type Parameters

• TRes

Parameters

callback

() => TRes

Returns

object

changeset

changeset: { _tag: "sessionChangeset"; data: Uint8Array; debug: any; } | { _tag: "no-op"; }

result

result: TRes