SqliteDbWrapper
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:34
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:46
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:35
Implementation of
Section titled “Implementation of”debugInfo
Section titled “debugInfo”debugInfo:
object
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:44
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:undefined| (readonly (string | number | Uint8Array<ArrayBuffer> | null)[] | { readonly [x: string]: string | number | Uint8Array<ArrayBuffer> | null; }) & Brand<…>;durationMs:number;queriedTables:ReadonlySet<string>;queryStr:string;rowsCount:undefined|number;startTimePerfNow:number; }>
execute()
Section titled “execute()”execute: {(
queryStr,bindValues?,options?):void; (queryBuilder,options?):void; }
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:228
Call Signature
Section titled “Call Signature”(
queryStr,bindValues?,options?):void
Parameters
Section titled “Parameters”queryStr
Section titled “queryStr”string
bindValues?
Section titled “bindValues?”options?
Section titled “options?”onRowsChanged?
Section titled “onRowsChanged?”(rowsChanged) => void
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”(
queryBuilder,options?):void
Parameters
Section titled “Parameters”queryBuilder
Section titled “queryBuilder”options?
Section titled “options?”onRowsChanged?
Section titled “onRowsChanged?”(rowsChanged) => void
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”select()
Section titled “select()”select: {<
T>(queryStr,bindValues?): readonlyT[]; <T>(queryBuilder):T; }
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:230
Call Signature
Section titled “Call Signature”<
T>(queryStr,bindValues?): readonlyT[]
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”queryStr
Section titled “queryStr”string
bindValues?
Section titled “bindValues?”Returns
Section titled “Returns”readonly T[]
Call Signature
Section titled “Call Signature”<
T>(queryBuilder):T
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”queryBuilder
Section titled “queryBuilder”QueryBuilder<T, any, any>
Returns
Section titled “Returns”T
Implementation of
Section titled “Implementation of”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get debug():
SqliteDebugInfo
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:68
Debug information (currently not persisted and only available at runtime)
Returns
Section titled “Returns”SqliteDebugInfo
Debug information (currently not persisted and only available at runtime)
Implementation of
Section titled “Implementation of”metadata
Section titled “metadata”Get Signature
Section titled “Get Signature”get metadata():
any
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:71
Returns
Section titled “Returns”any
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”cachedExecute()
Section titled “cachedExecute()”cachedExecute(
queryStr,bindValues?,options?):object
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:163
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
cachedSelect()
Section titled “cachedSelect()”cachedSelect<
T>(queryStr,bindValues?,options?): readonlyT[]
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:232
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[]
close()
Section titled “close()”close():
void
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:80
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:83
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”export()
Section titled “export()”export():
Uint8Array<ArrayBuffer>
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:303
Returns
Section titled “Returns”Uint8Array<ArrayBuffer>
Implementation of
Section titled “Implementation of”getTablesUsed()
Section titled “getTablesUsed()”getTablesUsed(
query):Set<string>
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:135
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:77
Parameters
Section titled “Parameters”Uint8Array<ArrayBuffer> | 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:89
Parameters
Section titled “Parameters”Uint8Array<ArrayBuffer>
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:74
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:130
Parameters
Section titled “Parameters”changeset
Section titled “changeset”Uint8Array<ArrayBuffer>
Returns
Section titled “Returns”void
session()
Section titled “session()”session():
SqliteDbSession
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:86
Returns
Section titled “Returns”SqliteDbSession
Implementation of
Section titled “Implementation of”txn<
TRes>(callback):TRes
Defined in: packages/@livestore/livestore/src/SqliteDbWrapper.ts:93
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:114
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<ArrayBuffer>;debug:any; } | {_tag:"no-op"; }
result
Section titled “result”result:
TRes