跳到主要内容

drop_alias()

此操作会删除指定的 Collection 别名。

Notes

此方法适用于 Dedicated serving 集群和按需计算。

  • 对于 serving 集群中的 Collection,请使用集群 Endpoint 创建 MilvusClient。

    • Free & Serverless

      https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com

    • Dedicated

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

  • 对于按需计算中的 Collection,请使用项目 Endpoint 创建 MilvusClient。

    https://{project-id}.{region}.api.zillizcloud.com

请求语法​

python
drop_alias(
alias: str,
timeout: float | None
) -> None

参数:

  • alias (str) -

    [必需]

    Collection 的别名。

    执行此操作前,请确保该别名已存在。否则将发生异常。

  • timeout (float | None)

    此操作的超时时长。

    将其设置为 None 表示当收到任意响应或发生任何错误时,此操作即超时。

返回类型:

NoneType

返回:

None

异常:

  • MilvusException

    当此操作期间发生任何错误时,将引发此异常,尤其是在您将 alias 设置为不存在的别名时。

  • BaseException

    当此操作失败时,将引发此异常。

示例​

python
from pymilvus import MilvusClient

# 1. Create a milvus client
client = MilvusClient(
uri="https://inxx-xxxxxxxxxxxx.api.gcp-us-west1.zillizcloud.com:19530",
token="user:password"
)

# 2. Create a collection
client.create_collection(collection_name="test_collection", dimension=5)

# 3. Create an alias for the collection
client.create_alias(collection_name="test_collection", alias="test")

# 4. Drop the alias
client.drop_alias(alias="test")
最低 SDK 版本v2.3.x