Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

@sms/store-sqlite

Interfaces

SqliteStore

Defined in: packages/drivers/store/sqlite/src/index.ts:5

Everything a kernel needs to persist: the event log, bundle blobs, and a database for plugins (key database).

Extends

Properties

blobs
blobs: BlobStore;

Defined in: packages/core/contracts/src/index.ts:48

Inherited from

Store.blobs

db
db: Database;

Defined in: packages/core/contracts/src/index.ts:46

Inherited from

Store.db

log
log: EventLog;

Defined in: packages/core/contracts/src/index.ts:47

Inherited from

Store.log

sqlite
sqlite: DatabaseSync;

Defined in: packages/drivers/store/sqlite/src/index.ts:7

The raw node:sqlite handle (system code only).

Methods

close()
close(): Promise<void>;

Defined in: packages/core/contracts/src/index.ts:49

Returns

Promise<void>

Inherited from

Store.close

Functions

openSqliteStore()

function openSqliteStore(path): Promise<SqliteStore>;

Defined in: packages/drivers/store/sqlite/src/index.ts:31

One SQLite file backs the event log, the bundle blobs and collection tables. Use ‘:memory:’ for tests.

Parameters

ParameterType
pathstring

Returns

Promise<SqliteStore>


sqliteDatabase()

function sqliteDatabase(db): Database;

Defined in: packages/drivers/store/sqlite/src/index.ts:11

Wrap a node:sqlite database as a Database driver.

Parameters

ParameterType
dbDatabaseSync

Returns

Database