sembast library Null safety

Classes

Boundary
Sort order boundary, lower or upper to use in a Finder
Database
Database.
DatabaseClient
Database client (either Database or Transaction)
DatabaseFactory
The database factory that allow opening database
DatabaseMode
The modes in which a Database can be opened.
Field
Special field access
FieldKey
Field Key utilities
FieldValue
Update values
Filter
Filter for searching into the database
Finder
Finder helper for searching a given store
QueryRef<K, V>
A query on a store.
RecordChange<K, V>
Record change info streamed during StoreRef.onChange.
RecordRef<K, V>
An immutable record reference
RecordSnapshot<K, V>
A read record
RecordsRef<K, V>
An immutable reference to multiple records
SembastCodec
The sembast codec to use to read/write records.
SortOrder
Sort order
StoreFactory<K, V>
Store factory interface
StoreRef<K, V>
A pointer to a store.
Transaction
Database transaction.

Extensions

SembastFilterCombination
Provides convenience methods for combining multiple Filters.
SembastRecordChangeExtension
Record change helper.
SembastRecordRefExtension
Record ref sembast public extension.
SembastRecordsRefExtension
Record ref sembast public extension.
SembastStoreRefExtension
Store ref public sembast extension.

Properties

intMapStoreFactory → StoreFactoryBase<int, Map<String, Object?>>
Store factory with key as int and value as Map
final
sembastCodecDefault SembastCodec
Json Codec with supports for DateTime and Blobs (UInt8List)
read / write
sembastDefaultTypeAdapters List<SembastTypeAdapter<Object, String>>
Support Timestamp and Blob
final
stringMapStoreFactory → StoreFactoryBase<String, Map<String, Object?>>
Store factory with key as String and value as Map
final

Functions

disableSembastCooperator() → void
Disable sembast cooperator.
enableSembastCooperator({int? delayMicroseconds, int? pauseMicroseconds}) → void
Re-enable sembast cooperator or change default pause and delay
sembastCodecWithAdapters(Iterable<SembastTypeAdapter> adapters) SembastCodec
Default codec has no toString converted and no signature. as format is expected to be compatible

Typedefs

OnVersionChangedFunction = FutureOr Function(Database db, int oldVersion, int newVersion)
Callback interface called when the existing version differs from the one expected.
TransactionRecordChangeListener<K, V> = FutureOr<void> Function(Transaction transaction, List<RecordChange<K, V>> changes)
Record change listener

Exceptions / Errors

DatabaseException
Database exception.