SqliteDb
Defined in: packages/@livestore/common/dist/sqlite-types.d.ts:11
Common interface for SQLite databases used by LiveStore to facilitate a consistent API across different platforms.
Always assumes a synchronous SQLite build with the bytecode and session extensions enabled.
Can be either in-memory or persisted to disk.
Type Parameters
Section titled “Type Parameters”TReq = any
TMetadata
Section titled “TMetadata”TMetadata extends TReq = TReq
Properties
Section titled “Properties”_tag:
"SqliteDb"
Defined in: packages/@livestore/common/dist/sqlite-types.d.ts:12
debug:
SqliteDebugInfo
Defined in: packages/@livestore/common/dist/sqlite-types.d.ts:15
Debug information (currently not persisted and only available at runtime)
import()
Section titled “import()”import: (
data) =>void
Defined in: packages/@livestore/common/dist/sqlite-types.d.ts:26
Parameters
Section titled “Parameters”Uint8Array<ArrayBufferLike> | SqliteDb<TReq, TReq>
Returns
Section titled “Returns”void
makeChangeset()
Section titled “makeChangeset()”makeChangeset: (
data) =>SqliteDbChangeset
Defined in: packages/@livestore/common/dist/sqlite-types.d.ts:30
Parameters
Section titled “Parameters”Uint8Array
Returns
Section titled “Returns”SqliteDbChangeset
metadata
Section titled “metadata”metadata:
TMetadata
Defined in: packages/@livestore/common/dist/sqlite-types.d.ts:13
Methods
Section titled “Methods”close()
Section titled “close()”close():
void
Defined in: packages/@livestore/common/dist/sqlite-types.d.ts:27
Returns
Section titled “Returns”void
destroy()
Section titled “destroy()”destroy():
void
Defined in: packages/@livestore/common/dist/sqlite-types.d.ts:28
Returns
Section titled “Returns”void
execute()
Section titled “execute()”Call Signature
Section titled “Call Signature”execute(
queryStr,bindValues?,options?):void
Defined in: packages/@livestore/common/dist/sqlite-types.d.ts:17
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”execute(
queryBuilder,options?):void
Defined in: packages/@livestore/common/dist/sqlite-types.d.ts:20
Parameters
Section titled “Parameters”queryBuilder
Section titled “queryBuilder”options?
Section titled “options?”onRowsChanged?
Section titled “onRowsChanged?”(rowsChanged) => void
Returns
Section titled “Returns”void
export()
Section titled “export()”export():
Uint8Array
Defined in: packages/@livestore/common/dist/sqlite-types.d.ts:25
Returns
Section titled “Returns”Uint8Array
prepare()
Section titled “prepare()”prepare(
queryStr):PreparedStatement
Defined in: packages/@livestore/common/dist/sqlite-types.d.ts:16
Parameters
Section titled “Parameters”queryStr
Section titled “queryStr”string
Returns
Section titled “Returns”select()
Section titled “select()”Call Signature
Section titled “Call Signature”select<
T>(queryStr,bindValues?): readonlyT[]
Defined in: packages/@livestore/common/dist/sqlite-types.d.ts:23
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”select<
T>(queryBuilder):T
Defined in: packages/@livestore/common/dist/sqlite-types.d.ts:24
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”queryBuilder
Section titled “queryBuilder”QueryBuilder<T, any, any>
Returns
Section titled “Returns”T
session()
Section titled “session()”session():
SqliteDbSession
Defined in: packages/@livestore/common/dist/sqlite-types.d.ts:29
Returns
Section titled “Returns”SqliteDbSession