BatchDescribeCollections()

Describes multiple collections in a single call.

pub async fn batch_describe_collections(&self, request: BatchDescribeCollectionsRequest) -> Result<BatchDescribeCollectionsResponse>

Request Syntax

let request = BatchDescribeCollectionsRequest::builder()
    .collection_names(["books", "articles"])
    .build()?;

REQUEST FIELDS:

  • database_name: Option<String>

    Name of the target database; uses the default database when empty.

  • collection_names: Vec<String>

    Names of the collections to describe. Use collection_name() to add one.

  • collection_ids: Vec<i64>

    Collection IDs to describe, as an alternative to names. Use collection_id() to add one; each ID must be positive.

RETURN TYPE:

Result

RETURNS:

A BatchDescribeCollectionsResponse containing the descriptions of the collections. Returns an Error if the operation fails.

BatchDescribeCollectionsResponse
    descriptions() // -> &[CollectionDesc]

METHODS:

  • descriptions() (&[CollectionDesc]) -

    The descriptions of the collections. See CollectionDesc.

Example

let request = BatchDescribeCollectionsRequest::builder()
    .collection_names(["books", "articles"])
    .build()?;
let resp = client.batch_describe_collections(request).await?;
for desc in resp.descriptions() {
    println!("name: {}", desc.get_collection_name());
}

Try Managed Milvus for Free

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

Get Started
Feedback

Was this page helpful?