Struct typedb_driver::Session

pub struct Session { /* private fields */ }

A session with a TypeDB database.

Implementations

impl Session

pub async fn new(database: Database, session_type: SessionType) -> Result<Self>

Opens a communication tunnel (session) to the given database with default options. See Session::new_with_options

pub async fn new_with_options( database: Database, session_type: SessionType, options: Options ) -> Result<Self>

Opens a communication tunnel (session) to the given database on the running TypeDB server.

Arguments

• database – The database with which the session connects
• session_type – The type of session to be created (DATA or SCHEMA)
• options – TypeDBOptions for the session

Examples

Session::new_with_options(database, session_type, options).await;

pub fn database_name(&self) -> &str

Returns the name of the database of the session.

Examples

session.database_name();

pub fn type_(&self) -> SessionType

The current session’s type (SCHEMA or DATA)

pub fn is_open(&self) -> bool

Checks whether this session is open.

Examples

session.is_open();

pub fn force_close(&self) -> Result

Closes the session. Before opening a new session, the session currently open should first be closed.

Examples

session.force_close();

pub fn on_close(&self, callback: impl FnMut() + Send + 'static)

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

Arguments

• function – The callback function.

Examples

session.on_close(function);

pub fn on_reopen(&self, callback: impl FnMut() + Send + 'static)

Registers a callback function which will be executed when this session is reopened. A session may be closed if it times out, or loses the connection to the database. In such situations, the session is reopened automatically when opening a new transaction.

Arguments

• function – The callback function.

Examples

session.on_reopen(function);

pub async fn transaction( &self, transaction_type: TransactionType ) -> Result<Transaction<'_>>

Opens a transaction to perform read or write queries on the database connected to the session. See Session::transaction_with_options

pub async fn transaction_with_options( &self, transaction_type: TransactionType, options: Options ) -> Result<Transaction<'_>>

Opens a transaction to perform read or write queries on the database connected to the session.

Arguments

• transaction_type – The type of transaction to be created (READ or WRITE)
• options – Options for the session

Examples

session.transaction_with_options(transaction_type, options).await;

Trait Implementations

impl Debug for Session

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

Formats the value using the given formatter.

impl Drop for Session

fn drop(&mut self)

Executes the destructor for this type.