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_core( 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

Connection::new_core("127.0.0.1:1729").await

pub async fn new_core_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.

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

Connection::new_core("127.0.0.1:1729", "rust").await

pub async fn new_cloud<T: AsRef<str> + Sync>( init_addresses: &Vec<T>, credentials: Credentials, driver_options: DriverOptions, ) -> Result<Self>

Creates a new TypeDB Cloud connection.

Arguments

• init_addresses — Addresses (host:port) on which TypeDB Cloud nodes are running
• credentials — The Credentials to connect with
• driver_options — The DriverOptions to connect with

pub async fn new_cloud_with_description<T: AsRef<str> + Sync>( init_addresses: &Vec<T>, credentials: Credentials, driver_options: DriverOptions, driver_lang: impl AsRef<str>, ) -> Result<Self>

Creates a new TypeDB Cloud connection.

Arguments

• init_addresses — Addresses (host:port) on which TypeDB Cloud nodes are 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

pub async fn new_cloud_with_translation<T, U>( address_translation: HashMap<T, U>, credential: Credentials, driver_options: DriverOptions, ) -> Result<Self>

where T: AsRef<str> + Sync, U: AsRef<str> + Sync,

Creates a new TypeDB Cloud connection.

Arguments

• address_translation — Translation map from addresses to be used by the driver for connection to addresses received from the TypeDB server(s)
• credential — The Credentials to connect with
• driver_options — The DriverOptions to connect with

pub async fn new_cloud_with_translation_with_description<T, U>( address_translation: HashMap<T, U>, credentials: Credentials, driver_options: DriverOptions, driver_lang: impl AsRef<str>, ) -> Result<Self>

where T: AsRef<str> + Sync, U: AsRef<str> + Sync,

Creates a new TypeDB Cloud connection.

Arguments

• address_translation — Translation map from addresses to be used by the driver for connection to addresses received from the TypeDB server(s)
• credentials — The Credentials to connect with
• driver_options — The DriverOptions to connect with
• driver_lang — The language of the driver connecting to the server

pub fn is_open(&self) -> bool

Checks it this connection is opened.

Examples

connection.is_open()

pub fn is_cloud(&self) -> bool

Check if the connection is to an Cloud server.

Examples

connection.is_cloud()

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>

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

pub fn force_close(&self) -> Result

Closes this connection if it is open.

Examples

connection.force_close()

Trait Implementations

impl Debug for TypeDBDriver

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

Formats the value using the given formatter.