Store class
Represents an ObjectBox database and works together with Box to allow getting and putting.
- Available Extensions
Constructors
- Store(ModelDefinition _defs, {String? directory, int? maxDBSizeInKB, int? fileMode, int? maxReaders, bool queriesCaseSensitiveDefault = true})
-
Creates a BoxStore using the model definition from your
objectbox.g.dart
file. - Store.fromReference(ModelDefinition _defs, ByteData _reference, {bool queriesCaseSensitiveDefault = true})
- Create a Dart store instance from an existing native store reference. Use this if you want to access the same store from multiple isolates. This results in two (or more) isolates having access to the same underlying native store. Concurrent access is ensured using implicit or explicit transactions. Note: make sure you don't use store in any of the isolates after the original store is closed (by calling close()).
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- reference → ByteData
-
Returns a store reference you can use to create a new store instance with
a single underlying native store. See
Store.attach()
for more details.no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
awaitAsyncCompletion(
) → bool - Await for all (including future) async submissions to be completed (the async queue becomes idle for a moment).
-
awaitAsyncSubmitted(
) → bool - Await for previously submitted async operations to be completed (the async queue does not have to become idle).
-
box<
T> () → Box< T> - Returns a cached Box instance.
-
close(
) → void - Closes this store.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
runInTransaction<
R> (TxMode mode, R fn()) → R -
Executes a given function inside a transaction. Returns
fn
's result. Aborts a transaction and rethrows on exception or iffn
is asynchronous. -
syncClient(
) → SyncClient? - Return an existing SyncClient associated with the store or null if not available. Use Sync.client() to create one first.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited