Struct Transaction

pub struct Transaction { /* private fields */ }

A transaction with a TypeDB database.

Implementations

impl Transaction

pub fn is_open(&self) -> bool

Closes the transaction.

Examples

transaction.close()

pub fn query( &self, query: impl AsRef<str>, ) -> impl Promise<'static, Result<QueryAnswer>>

Performs a TypeQL query with default options. See Transaction::query_with_options

pub fn query_with_options( &self, query: impl AsRef<str>, options: QueryOptions, ) -> impl Promise<'static, Result<QueryAnswer>>

Performs a TypeQL query in this transaction.

Arguments

• query — The TypeQL query to be executed
• options — The QueryOptions to execute the query with

Examples

transaction.query_with_options(query, options)

pub fn type_(&self) -> TransactionType

Retrieves the transaction’s type (READ or WRITE).

pub fn on_close( &self, callback: impl FnOnce(Option<Error>) + Send + Sync + 'static, )

Registers a callback function which will be executed when this transaction is closed.

Arguments

• function — The callback function.

Examples

transaction.on_close(function)

pub fn force_close(&self)

Closes the transaction.

Examples

transaction.force_close()

pub fn commit(self) -> impl Promise<'static, Result>

Commits the changes made via this transaction to the TypeDB database. Whether or not the transaction is commited successfully, it gets closed after the commit call.

Examples

transaction.commit().await

pub fn rollback(&self) -> impl Promise<'_, Result>

Rolls back the uncommitted changes made via this transaction.

Examples

transaction.rollback().await

Trait Implementations

impl Debug for Transaction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.