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
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SqliteDbWrapper(
__namedParameters):SqliteDbWrapper
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:48
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”{ rootSpanContext: Context; tracer: Tracer; }
otel.rootSpanContext
Section titled “otel.rootSpanContext”Context
otel.tracer
Section titled “otel.tracer”Tracer
Returns
Section titled “Returns”SqliteDbWrapper
Properties
Section titled “Properties”_tag:
"SqliteDb"
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:37
Implementation of
Section titled “Implementation of”debugInfo
Section titled “debugInfo”debugInfo:
object
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:46
events
Section titled “events”events:
BoundArray<readonly [string,any]>
queryFrameCount
Section titled “queryFrameCount”queryFrameCount:
number
queryFrameDuration
Section titled “queryFrameDuration”queryFrameDuration:
number
slowQueries
Section titled “slowQueries”slowQueries:
BoundArray<{bindValues:any;durationMs:number;queriedTables:ReadonlySet<string>;queryStr:string;rowsCount:undefined|number;startTimePerfNow:number; }>
metadata
Section titled “metadata”metadata:
any
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:70
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”close()
Section titled “close()”close():
void
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:77
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”destroy()
Section titled “destroy()”destroy():
void
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:80
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”execute()
Section titled “execute()”execute(
queryStr,bindValues?,options?):object
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:160
Parameters
Section titled “Parameters”queryStr
Section titled “queryStr”string
bindValues?
Section titled “bindValues?”options?
Section titled “options?”hasNoEffects?
Section titled “hasNoEffects?”boolean
onRowsChanged?
Section titled “onRowsChanged?”(rowsChanged) => void
otelContext?
Section titled “otelContext?”Context
writeTables?
Section titled “writeTables?”ReadonlySet<string>
Returns
Section titled “Returns”object
durationMs
Section titled “durationMs”durationMs:
number
Implementation of
Section titled “Implementation of”export()
Section titled “export()”export():
Uint8Array<ArrayBufferLike>
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:295
Returns
Section titled “Returns”Uint8Array<ArrayBufferLike>
Implementation of
Section titled “Implementation of”getTablesUsed()
Section titled “getTablesUsed()”getTablesUsed(
query):Set<string>
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:132
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Set<string>
import()
Section titled “import()”import(
data):void
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:74
Parameters
Section titled “Parameters”Uint8Array<ArrayBufferLike> | SqliteDb<any, any>
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”makeChangeset()
Section titled “makeChangeset()”makeChangeset(
data):SqliteDbChangeset
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:86
Parameters
Section titled “Parameters”Uint8Array
Returns
Section titled “Returns”SqliteDbChangeset
Implementation of
Section titled “Implementation of”prepare()
Section titled “prepare()”prepare(
queryStr):PreparedStatement
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:71
Parameters
Section titled “Parameters”queryStr
Section titled “queryStr”string
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”rollback()
Section titled “rollback()”rollback(
changeset):void
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:127
Parameters
Section titled “Parameters”changeset
Section titled “changeset”Uint8Array
Returns
Section titled “Returns”void
select()
Section titled “select()”select<
T>(queryStr,bindValues?,options?): readonlyT[]
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:224
Type Parameters
Section titled “Type Parameters”T = any
Parameters
Section titled “Parameters”queryStr
Section titled “queryStr”string
bindValues?
Section titled “bindValues?”options?
Section titled “options?”otelContext?
Section titled “otelContext?”Context
queriedTables?
Section titled “queriedTables?”ReadonlySet<string>
skipCache?
Section titled “skipCache?”boolean
Returns
Section titled “Returns”readonly T[]
Implementation of
Section titled “Implementation of”session()
Section titled “session()”session():
SqliteDbSession
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:83
Returns
Section titled “Returns”SqliteDbSession
Implementation of
Section titled “Implementation of”txn<
TRes>(callback):TRes
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:90
Type Parameters
Section titled “Type Parameters”TRes
Parameters
Section titled “Parameters”callback
Section titled “callback”() => TRes
Returns
Section titled “Returns”TRes
withChangeset()
Section titled “withChangeset()”withChangeset<
TRes>(callback):object
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:111
Type Parameters
Section titled “Type Parameters”TRes
Parameters
Section titled “Parameters”callback
Section titled “callback”() => TRes
Returns
Section titled “Returns”object
changeset
Section titled “changeset”changeset: {
_tag:"sessionChangeset";data:Uint8Array;debug:any; } | {_tag:"no-op"; }
result
Section titled “result”result:
TRes