DescribeDatabase()

Retrieves a database’s metadata and properties.

pub async fn describe_database(&self, request: DescribeDatabaseRequest) -> Result<DescribeDatabaseResponse>

Request Syntax

let request = DescribeDatabaseRequest::builder()
    .database_name("my_database")
    .build()?;

REQUEST FIELDS:

  • database_name: String

    Name of the database to describe. Required.

RETURNS:

Result

DescribeDatabaseResponse exposes database_name(), database_id(), created_timestamp(), and properties() returning the database properties as a HashMap<String, String>. Returns an Error on failure.

Example

let request = DescribeDatabaseRequest::builder()
    .database_name("my_database")
    .build()?;
let resp = client.describe_database(request).await?;
println!("properties: {:?}", resp.properties());

Try Managed Milvus for Free

Zilliz Cloud is hassle-free, powered by Milvus and 10x faster.

Get Started
Feedback

Was this page helpful?