Light
Dark
System

Transactions

EdgeQL supports atomic transactions. The transaction API consists of several commands:

start transaction

Start a transaction, specifying the isolation level, access mode (read only vs read write), and deferrability.

declare savepoint

Establish a new savepoint within the current transaction. A savepoint is a intermediate point in a transaction flow that provides the ability to partially rollback a transaction.

release savepoint

Destroys a savepoint previously defined in the current transaction.

rollback to savepoint

Rollback to the named savepoint. All changes made after the savepoint are discarded. The savepoint remains valid and can be rolled back to again later, if needed.

rollback

Rollback the entire transaction. All updates made within the transaction are discarded.

commit

Commit the transaction. All changes made by the transaction become visible to others and will persist if a crash occurs.

There is rarely a reason to use these commands directly. All EdgeDB client libraries provide dedicated transaction APIs that handle transaction creation under the hood.

Using an EdgeQL query string:

Copy
client.transaction(async tx => {
  await tx.execute(`insert Fish { name := 'Wanda' };`);
});

Using the querybuilder:

Copy
const query = e.insert(e.Fish, {
  name: 'Wanda'
});
client.transaction(async tx => {
  await query.run(tx);
});

Full documentation at Client Libraries > TypeScript/JS;

Copy
async for tx in client.transaction():
    async with tx:
        await tx.execute("insert Fish { name := 'Wanda' };")

Full documentation at Client Libraries > Python;

Copy
err := client.Tx(ctx, func(ctx context.Context, tx *Tx) error {
        query := "insert Fish { name := 'Wanda' };"
        if e := tx.Execute(ctx, query); e != nil {
                return e
        }
})

Full documentation at Client Libraries > Go.

Light
Dark
System