Skip to content

SqliteDb

Defined in: packages/@livestore/common/dist/adapter-types.d.ts:80

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

TReq = any

TMetadata extends TReq = TReq

Properties

_tag

_tag: "SqliteDb"

Defined in: packages/@livestore/common/dist/adapter-types.d.ts:81


import()

import: (data) => void

Defined in: packages/@livestore/common/dist/adapter-types.d.ts:89

Parameters

data

Uint8Array<ArrayBufferLike> | SqliteDb<TReq, TReq>

Returns

void


makeChangeset()

makeChangeset: (data) => SqliteDbChangeset

Defined in: packages/@livestore/common/dist/adapter-types.d.ts:93

Parameters

data

Uint8Array

Returns

SqliteDbChangeset


metadata

metadata: TMetadata

Defined in: packages/@livestore/common/dist/adapter-types.d.ts:82

Methods

close()

close(): void

Defined in: packages/@livestore/common/dist/adapter-types.d.ts:90

Returns

void


destroy()

destroy(): void

Defined in: packages/@livestore/common/dist/adapter-types.d.ts:91

Returns

void


execute()

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

Defined in: packages/@livestore/common/dist/adapter-types.d.ts:84

Parameters

queryStr

string

bindValues?

PreparedBindValues

options?
onRowsChanged?

(rowsChanged) => void

Returns

void


export()

export(): Uint8Array

Defined in: packages/@livestore/common/dist/adapter-types.d.ts:88

Returns

Uint8Array


prepare()

prepare(queryStr): PreparedStatement

Defined in: packages/@livestore/common/dist/adapter-types.d.ts:83

Parameters

queryStr

string

Returns

PreparedStatement


select()

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

Defined in: packages/@livestore/common/dist/adapter-types.d.ts:87

Type Parameters

T

Parameters

queryStr

string

bindValues?

PreparedBindValues

Returns

readonly T[]


session()

session(): SqliteDbSession

Defined in: packages/@livestore/common/dist/adapter-types.d.ts:92

Returns

SqliteDbSession