Struct Database

pub struct Database { /* private fields */ }

A TypeDB database

Implementations

impl Database

pub fn name(&self) -> &str

Retrieves the database name as a string.

pub fn replicas_info(&self) -> Vec<ReplicaInfo>

Returns the Replica instances for this database. Only works in TypeDB Cloud / Enterprise

Examples

database.replicas_info()

pub fn primary_replica_info(&self) -> Option<ReplicaInfo>

Returns the primary replica for this database. Only works in TypeDB Cloud / Enterprise

Examples

database.primary_replica_info()

pub fn preferred_replica_info(&self) -> Option<ReplicaInfo>

Returns the preferred replica for this database. Operations which can be run on any replica will prefer to use this replica. Only works in TypeDB Cloud / Enterprise

Examples

database.preferred_replica_info();

pub async fn delete(self: Arc<Self>) -> Result

Deletes this database.

Examples

database.delete().await;

pub async fn schema(&self) -> Result<String>

Returns a full schema text as a valid TypeQL define query string.

Examples

database.schema().await;

pub async fn type_schema(&self) -> Result<String>

Returns the types in the schema as a valid TypeQL define query string.

Examples

database.type_schema().await;

pub async fn export_to_file( &self, schema_file_path: impl AsRef<Path>, data_file_path: impl AsRef<Path>, ) -> Result

Export a database into a schema definition and a data files saved to the disk. This is a blocking operation and may take a significant amount of time depending on the database size.

Arguments

• schema_file_path — The path to the schema definition file to be created
• data_file_path — The path to the data file to be created

Examples

database.export_to_file(schema_path, data_path).await;

Trait Implementations

impl Debug for Database

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

Formats the value using the given formatter.