Struct TypeDBDriver

pub struct TypeDBDriver { /* private fields */ }

A connection to a TypeDB server which serves as the starting point for all interaction.

Implementations

impl TypeDBDriver

pub const DEFAULT_ADDRESS: &'static str = "localhost:1729"

pub async fn new( address: impl AsRef<str>, credentials: Credentials, driver_options: DriverOptions, ) -> Result<Self>

Creates a new TypeDB Server connection.

Arguments

• address — The address (host:port) on which the TypeDB Server is running
• credentials — The Credentials to connect with
• driver_options — The DriverOptions to connect with

Examples

TypeDBDriver::new("127.0.0.1:1729").await

pub async fn new_with_description( address: impl AsRef<str>, credentials: Credentials, driver_options: DriverOptions, driver_lang: impl AsRef<str>, ) -> Result<Self>

Creates a new TypeDB Server connection with a description. This method is generally used by TypeDB drivers built on top of the Rust driver. In other cases, use Self::new instead.

Arguments

• address — The address (host:port) on which the TypeDB Server is running
• credentials — The Credentials to connect with
• driver_options — The DriverOptions to connect with
• driver_lang — The language of the driver connecting to the server

Examples

TypeDBDriver::new_with_description("127.0.0.1:1729", "rust").await

pub fn is_open(&self) -> bool

Checks it this connection is opened.

Examples

driver.is_open()

pub fn databases(&self) -> &DatabaseManager

pub fn users(&self) -> &UserManager

pub async fn transaction( &self, database_name: impl AsRef<str>, transaction_type: TransactionType, ) -> Result<Transaction>

Opens a transaction with default options. See TypeDBDriver::transaction_with_options

pub async fn transaction_with_options( &self, database_name: impl AsRef<str>, transaction_type: TransactionType, options: TransactionOptions, ) -> Result<Transaction>

Performs a TypeQL query in this transaction.

Arguments

• database_name — The name of the database to connect to
• transaction_type — The TransactionType to open the transaction with
• options — The TransactionOptions to open the transaction with

Examples

transaction.transaction_with_options(database_name, transaction_type, options)

pub fn force_close(&self) -> Result

Closes this connection if it is open.

Examples

driver.force_close()

Trait Implementations

impl Debug for TypeDBDriver

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

Formats the value using the given formatter.