sdb/sdb library

Simple DB.

Opinionated strong type API. Design around indexed db API which is a basic database API easy to implement with good web support and robust desktop implementation using idb_sqflite

In memory available (mainly for testing) and io implementation using sembast

Classes

SdbBoundaries<T extends Object>

Lower and upper boundaries.

SdbBoundary<T extends Object>

Simple boundary definition. include default to true for lower boundary and false for upper boundary.

SdbClient

Database client (db or transaction).

SdbDatabase

SimpleDb definition.

SdbDatabaseSchema

Database schema

SdbDatabaseSchemaDef

Database schema definition

SdbFactory

Sdb Factory

SdbFindOptions

Common find options

SdbIndex1Ref<K extends SdbKey, V extends SdbValue, I extends SdbIndexKey>

Index on 1 field

SdbIndex2Ref<K extends SdbKey, V extends SdbValue, I1 extends SdbIndexKey, I2 extends SdbIndexKey>

Index on 2 fields

SdbIndex3Ref<K extends SdbKey, V extends SdbValue, I1 extends SdbIndexKey, I2 extends SdbIndexKey, I3 extends SdbIndexKey>

Index on 3 fields

SdbIndex4Ref<K extends SdbKey, V extends SdbValue, I1 extends SdbIndexKey, I2 extends SdbIndexKey, I3 extends SdbIndexKey, I4 extends SdbIndexKey>

Index on 4 fields

SdbIndexRecordKey<K extends SdbKey, V extends SdbValue, I extends SdbIndexKey>

Index record key.

SdbIndexRecordRef<K extends SdbKey, V extends SdbValue, I extends SdbIndexKey>

Index record reference at a given index key. An index key may refer to multiple records.

SdbIndexRecordSnapshot<K extends SdbKey, V extends SdbValue, I extends SdbIndexKey>

Index record snapshot.

SdbIndexRef<K extends SdbKey, V extends SdbValue, I extends SdbIndexKey>

Index reference.

SdbIndexSchema

Index schema

SdbIndexSchemaDef

Index schema definition

SdbKeyPath

Key path abstraction

SdbLowerBoundary<T extends Object>

Lower boundary. (included by default).

SdbMultiStoreTransaction

Multi-store transaction.

SdbOpenDatabase

Database during open.

SdbOpenIndexRef<K extends SdbKey, V extends SdbValue, I extends SdbIndexKey>

Index during open.

SdbOpenStoreRef<K extends SdbKey, V extends SdbValue>

Store during open.

SdbRecordKey<K extends SdbKey, V extends SdbValue>

Record snapshot.

SdbRecordSnapshot<K extends SdbKey, V extends SdbValue>

Record snapshot.

SdbSingleStoreTransaction<K extends SdbKey, V extends SdbValue>

Single store transaction.

SdbStoreRef<K extends SdbKey, V extends SdbValue>

A simple db store definition.

SdbStoreSchema

Store schema

SdbStoreSchemaDef

Store schema definition

SdbTransaction

SimpleDb transaction.

SdbTransactionIndexRef<K extends SdbKey, V extends SdbValue, I extends SdbIndexKey>

Transaction store reference.

SdbTransactionStoreRef<K extends SdbKey, V extends SdbValue>

Transaction store reference.

SdbUpperBoundary<T extends Object>

Upper boundary. (excluded by default).

SdbVersionChangeEvent

Event passed to SdbOnVersionChangeCallback.

Enums

SdbTransactionMode

Transaction mode.

Extensions

SchemaSdbDatabaseExtension on SdbDatabase

Database schema extension on database

SdbClientExtension on SdbClient

Database client (db or transaction).

SdbDatabaseExtension on SdbDatabase

SimpleDb methods.

SdbDatabaseIdbExt on SdbDatabase

Helper idb extension.

SdbDatabaseSchemaExtension on SdbDatabaseSchema

Database schema extension

SdbFactoryExtension on SdbFactory

Sdb Factory extension.

SdbFactorySchemaExtension on SdbFactory

Factory schema extension

SdbFilterRecordSnapshotExt on SdbFilterRecordSnapshot

Extension to allow getting the primary key for index requests

SdbIndex1RefExtension on SdbIndex1Ref<K, V, I>

Extension on index on 1 field.

SdbIndex2RefExtension on SdbIndex2Ref<K, V, I1, I2>

Extension on index on 2 fields.

SdbIndex3RefExtension on SdbIndex3Ref<K, V, I1, I2, I3>

Extension on index on 3 fields.

SdbIndex4RefExtension on SdbIndex4Ref<K, V, I1, I2, I3, I4>

Extension on index on 4 fields.

SdbIndexRecordKeyListExt on List<SdbIndexRecordKey<K, V, I>>

Common extension

SdbIndexRecordRefExtension on SdbIndexRecordRef<K, V, I>

Index record reference extension.

SdbIndexRecordSnapshotListExt on List<SdbIndexRecordSnapshot<K, V, I>>

Common extension

SdbIndexRefExtension on SdbIndexRef<K, V, I>

Index methods.

SdbIndexRefSchemaExtension on SdbIndexRef<SdbKey, SdbValue, SdbIndexKey>

Store schema extension on store ref

SdbIndexSchemaExtension on SdbIndexSchema

Index schema extension

SdbKeyPathExtension on SdbKeyPath

Key path extension

SdbMultiStoreTransactionExtension on SdbMultiStoreTransaction

Transaction store actions.

SdbOpenDatabaseExtension on SdbOpenDatabase

Database action during open.

SdbOpenStoreRefExtension on SdbOpenStoreRef<K, V>

Store action during open.

SdbRecordKeyListExt on List<SdbRecordKey<K, V>>

Common extension

SdbRecordRefExtension on SdbRecordRef<K, V>

Store methods.

SdbRecordSnapshotListExt on List<SdbRecordSnapshot<K, V>>

Common extension

SdbSingleStoreTransactionExtension on SdbSingleStoreTransaction<K, V>

Single store transaction extension.

SdbStoreRefDbExtension on SdbStoreRef<K, V>

Store reference implementation.

SdbStoreRefExtension on SdbStoreRef<K, V>

Store methods.

SdbStoreRefSchemaExtension on SdbStoreRef<SdbKey, SdbValue>

Store schema extension on store ref

SdbStoreSchemaExtension on SdbStoreSchema

Store schema extension

SdbTransactionExtension on SdbTransaction

SimpleDb transaction extension.

SdbTransactionStoreRefExtension on SdbTransactionStoreRef<K, V>

Transaction store actions.

Constants

kSdbDartIsWeb → const bool

Web constant helper (needed for non-flutter app)

Properties

sdbFactoryIo → SdbFactory

Sembast io factory.

final

sdbFactoryMemory → SdbFactory

Memory factory.

final

sdbFactoryWeb → SdbFactory

Native (browser) factory.

final

sdbFactoryWebWorker → SdbFactory

Native (web worker) factory.

final

Functions

newSdbFactoryMemory() → SdbFactory

New memory factory.

sdbFactoryFromIdb(IdbFactory idbFactory) → SdbFactory

Factory from idb factory.

Typedefs

SdbFilter = Filter

Sdb filter

SdbFilterRecordSnapshot = RecordSnapshot<Object?, Object?>

Sdb custom filter matcher

SdbIndexKey = Object

Value type. Index type.

SdbKey = Object

Key type

SdbModel = Map<String, Object?>

Model class.

SdbOnVersionChangeCallback = FutureOr<void> Function(SdbVersionChangeEvent event)

Callback for SdbOpenDatabase.onVersionChange.

SdbRecordRef<K extends SdbKey, V extends SdbValue> = SdbRecordKey<K, V>

Record reference.

SdbValue = Object

Value type