API reference@melon-db/db

StorageAdapter

@melon-db/db — StorageAdapter

@melon-db/db API Reference

Interface: StorageAdapter

Defined in: packages/melon-db/src/adapter.ts:65

Properties

Property	Modifier	Type	Description	Defined in
`capabilities`	`readonly`	`StorageAdapterCapabilities`	-	packages/melon-db/src/adapter.ts:67
`meta?`	`readonly`	`MetaStore`	Populated after initialize when adapter supports meta storage.	packages/melon-db/src/adapter.ts:71
`name`	`readonly`	`string`	-	packages/melon-db/src/adapter.ts:66
`syncOutbox?`	`readonly`	`SyncOutboxStore`	Populated after initialize when sync is enabled.	packages/melon-db/src/adapter.ts:69

Methods

close()

close(): Promise<void>

Defined in: packages/melon-db/src/adapter.ts:84

Returns

Promise<void>

count()

count(query): Promise<AdapterCountResult>

Defined in: packages/melon-db/src/adapter.ts:76

Parameters

Parameter	Type
`query`	`PreparedQuery`

Returns

Promise<AdapterCountResult>

find()

find(query): Promise<AdapterFindResult>

Defined in: packages/melon-db/src/adapter.ts:75

Parameters

Parameter	Type
`query`	`PreparedQuery`

Returns

Promise<AdapterFindResult>

flushObservationQueue()?

optional flushObservationQueue(): Promise<void>

Defined in: packages/melon-db/src/adapter.ts:82

Drains SQLite observation trigger events and invalidates matching queries.

Returns

Promise<void>

getChangedCollections()?

optional getChangedCollections(sinceVersion): Promise<AdapterChangeSet>

Defined in: packages/melon-db/src/adapter.ts:79

Parameters

Parameter	Type
`sinceVersion`	`number`

Returns

Promise<AdapterChangeSet>

getLastQueryDebug()?

optional getLastQueryDebug(): QueryExecutionDebug | undefined

Defined in: packages/melon-db/src/adapter.ts:83

Returns

QueryExecutionDebug | undefined

initialize()

initialize(schema, options?): Promise<void>

Defined in: packages/melon-db/src/adapter.ts:73

Parameters

Parameter	Type
`schema`	`MelonSchema`
`options?`	`InitializeOptions`

Returns

Promise<void>

observeQuery()?

optional observeQuery(query, onChange): () => void

Defined in: packages/melon-db/src/adapter.ts:80

Parameters

Parameter	Type
`query`	`PreparedQuery`
`onChange`	() => `void`

Returns

() => void

prepare()?

optional prepare(query): Promise<PreparedQuery>

Defined in: packages/melon-db/src/adapter.ts:74

Parameters

Parameter	Type
`query`	`PreparedQuery`

Returns

Promise<PreparedQuery>

transaction()

transaction<T>(fn): Promise<T>

Defined in: packages/melon-db/src/adapter.ts:78

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type
`fn`	() => `Promise`<`T`>

Returns

Promise<T>

write()

write(operation): Promise<void>

Defined in: packages/melon-db/src/adapter.ts:77

Parameters

Parameter	Type
`operation`	`AdapterWriteOperation`

Returns

Promise<void>

RelationDefinition

@melon-db/db — RelationDefinition

StorageAdapterCapabilities

@melon-db/db — StorageAdapterCapabilities