describe_database()

Addedv2.5.x

This operation lists detailed information about the specified database.

📘Notes

This method applies only to dedicated serving clusters and on-demand compute.

• For a database in a dedicated serving clusters, create MilvusClient with the cluster endpoint.

  • Free & Serverless

    https://{cluster-id}.serverless.{region}.cloud.zilliz.com.cn

  • Dedicated

    https://{cluster-id}.{region}.vectordb.zilliz.com.cn:19530

• For a database for on-demand compute, create MilvusClient with the project endpoints.

  https://{project-id}.{region}.api.cloud.zilliz.com.cn

Request Syntax

describe_database(
    db_name: str, 
    timeout: Optional[float] = None,
    **kwargs,
) -> Dict

PARAMETERS:

• db_name (string) -

  [REQUIRED]

  Name of the database to describe.

• timeout (float | None) -

  The timeout duration for this operation. Setting this to None indicates that it timeouts when a response arrives, or an error occurs.

RETURN TYPE:

Dict

RETURNS:

A dictionary that contains detailed information about the specified database.

EXCEPTIONS:

• MilvusException - Raised if any error occurs during this operation.

Examples

from pymilvus import MilvusClient

client = MilvusClient(uri, token) # db = "default" 

client.describe_database(
    db_name="my_db"
)

# {
#   "name": "my_db",
#   "a": "b",
#.  "c": "d",
# }