Struct typedb_driver::driver::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 async fn new_core(address: impl AsRef<str>) -> Result<Self>

Creates a new TypeDB Server connection.

Arguments

• address – The address (host:port) on which the TypeDB Server is running

Examples

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

pub async fn new_core_with_description( address: impl AsRef<str>, driver_lang: impl AsRef<str>, driver_version: impl AsRef<str>, ) -> Result<Self>

pub fn new_cloud<T: AsRef<str> + Sync>( init_addresses: &[T], credential: Credential, ) -> Result<Self>

Creates a new TypeDB Cloud connection.

Arguments

• init_addresses – Addresses (host:port) on which TypeDB Cloud nodes are running
• credential – User credential and TLS encryption setting

Examples

Connection::new_cloud(
    &["localhost:11729", "localhost:21729", "localhost:31729"],
    Credential::with_tls(
        "admin",
        "password",
        Some(&PathBuf::from(
            std::env::var("ROOT_CA")
                .expect("ROOT_CA environment variable needs to be set for cloud tests to run"),
        )),
    )?,
)

pub fn new_cloud_with_translation<T, U>( address_translation: HashMap<T, U>, credential: Credential, ) -> 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 – User credential and TLS encryption setting

Examples

Connection::new_cloud_with_translation(
    [
        ("typedb-cloud.ext:11729", "localhost:11729"),
        ("typedb-cloud.ext:21729", "localhost:21729"),
        ("typedb-cloud.ext:31729", "localhost:31729"),
    ].into(),
    credential,
)

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.

Examples

connection.force_close()

Trait Implementations

impl Debug for TypeDBDriver

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

Formats the value using the given formatter.