RecordRef<K extends Key?, V extends Value?> class abstract

An immutable record reference

Available extensions

• SembastRecordRefExtension
• SembastRecordRefSyncExtension

Constructors

RecordRef()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

key → K

Record key, never null.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

store → StoreRef<K, V>

Store reference.

no setter

Methods

add(DatabaseClient databaseClient, V value) → Future<K?>

Available on RecordRef<K, V>, provided by the SembastRecordRefExtension extension

Create the record if it does not exist.

cast<RK extends Key?, RV extends Value?>() → RecordRef<RK, RV>

Cast if needed.

delete(DatabaseClient databaseClient) → Future<K?>

Available on RecordRef<K, V>, provided by the SembastRecordRefExtension extension

Delete the record. Returns the key if deleted, null if not found.

exists(DatabaseClient databaseClient) → Future<bool>

Available on RecordRef<K, V>, provided by the SembastRecordRefExtension extension

Return true if the record exists.

existsSync(DatabaseClient databaseClient) → bool

Available on RecordRef<K, V>, provided by the SembastRecordRefSyncExtension extension

Return true if the record exists synchronously.

get(DatabaseClient databaseClient) → Future<V?>

Available on RecordRef<K, V>, provided by the SembastRecordRefExtension extension

Get a record value from the database.

getSnapshot(DatabaseClient databaseClient) → Future<RecordSnapshot<K, V>?>

Available on RecordRef<K, V>, provided by the SembastRecordRefExtension extension

Get a record snapshot from the database.

getSnapshotSync(DatabaseClient databaseClient) → RecordSnapshot<K, V>?

Available on RecordRef<K, V>, provided by the SembastRecordRefSyncExtension extension

Get a record snapshot from the database synchronously.

getSync(DatabaseClient databaseClient) → V?

Available on RecordRef<K, V>, provided by the SembastRecordRefSyncExtension extension

Get a record value from the database synchronously.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onSnapshot(Database database) → Stream<RecordSnapshot<K, V>?>

Available on RecordRef<K, V>, provided by the SembastRecordRefExtension extension

Get a stream of a record snapshot from the database.

onSnapshotSync(Database database) → Stream<RecordSnapshot<K, V>?>

Available on RecordRef<K, V>, provided by the SembastRecordRefSyncExtension extension

Get a stream of a record snapshot from the database.

put(DatabaseClient databaseClient, V value, {bool? merge, bool? ifNotExists}) → Future<V>

Available on RecordRef<K, V>, provided by the SembastRecordRefExtension extension

Save a record, create if needed.

snapshot(V value) → RecordSnapshot<K, V>

Available on RecordRef<K, V>, provided by the SembastRecordRefExtension extension

Create a snapshot of a record with a given value.

toString() → String

A string representation of this object.

inherited

update(DatabaseClient databaseClient, V value) → Future<V?>

Available on RecordRef<K, V>, provided by the SembastRecordRefExtension extension

Update a record.

Operators

operator ==(Object other) → bool

The equality operator.

inherited