2.8 KiB
title | weight | description | aliases | |
---|---|---|---|---|
Transactions | 70 | Run multiple queries atomically |
|
Moor has support for transactions and allows multiple queries to run atomically,
so that none of their changes is visible to the main database until the transaction
is finished.
To begin a transaction, call the transaction
method on your database or a DAO.
It takes a function as an argument that will be run transactionally. In the
following example, which deals with deleting a category, we move all todo entries
in that category back to the default category:
Future deleteCategory(Category category) {
return transaction((_) async {
// first, move the affected todo entries back to the default category
await customUpdate(
'UPDATE todos SET category = NULL WHERE category = ?',
updates: {todos},
variables: [Variable.withInt(category.id)],
);
// then, delete the category
await delete(categories).delete(category);
});
}
{{% alert title="About that _" color="info" %}}
You might have noticed that _
parameter on the transaction()
callback. That parameter would
be a special version of the database that runs all the methods called on it inside the transaction.
In previous moor versions, it was important to call everything on that parameter, e.g.
transaction((db) async {
await db.delete(categories).delete(category);
});
Starting from moor 1.6, this is no longer neccessary, we can figure out that you meant to run that
in a transaction because it was called from inside a transaction
callback. We're going to remove
that parameter entirely in moor 2.0.
{{% /alert %}}
⚠️ Gotchas
There are a couple of things that should be kept in mind when working with transactions:
- Await all calls: All queries inside the transaction must be
await
-ed. The transaction will complete when the inner method completes. Withoutawait
, some queries might be operating on the transaction after it has been closed! This can cause data loss or runtime crashes. - No select streams in transactions: Inside a
transaction
callback, select statements can't be.watch()
ed. The reasons behind this is that it's unclear how a stream should behave when a transaction completes. Should the stream complete as well? Update to data changes made outside of the transaction? Both seem inconsistent, so moor forbids this.
Transactions and query streams
Query streams that have been created outside a transaction work nicely together with updates made in a transaction: All changes to tables will only be reported after the transaction completes. Updates inside a transaction don't have an immediate effect on streams, so your data will always be consistent.
However, as mentioned above, note that streams can't be created inside a transaction
block.