describe_database()
Deprecated.
This API is an ORM-style PyMilvus API and will be removed in PyMilvus 3.1. Use MilvusClient instead.
This operation describes a database using the provided database name.
Request Syntax
describe_database(
db_name: str,
using: str = "default",
timeout: float | None
)
PARAMETERS:
db_name (string) -
[REQUIRED]
Name of the database to be described.
using (string) -
Alias of the connection. Defaults to default.
timeout (float | None)
The timeout duration for this operation. Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.
RETURN TYPE:
dict
RETURNS:
A dictionary that contains the database information.
EXCEPTIONS:
-
This exception will be raised when any error occurs during this operation.
Example
from pymilvus import connections, db
conn = connections.connect(
host="127.0.0.1",
port=19530
)
db.describe_database(db_name="test")