alter_alias()
此操作会将一个 Collection 的别名重新分配给另一个 Collection。
此方法适用于专用 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
请求语法
alter_alias(
collection_name: str,
alias: str,
timeout: float | None
) -> None
参数:
-
collection_name (str) -
[必需]
要重新分配别名的目标 Collection 的名称。
-
alias (str) -
[必需]
Collection 的别名。请注意,该别名应事先存在。
Note什么是 Collection 别名?
Collection 别名是 Collection 的附加名称。当您希望在不更改代码的情况下将应用程序切换到新的 Collection 时,Collection 别名会很有用。
在 Zilliz Cloud 中,Collection 别名是全局唯一标识符。一个别名只能且仅能分配给一个 Collection。反之,一个 Collection 可以有多个别名。
以下是将一个 Collection 的别名重新分配给另一个 Collection 的示例:
假设有两个 Collection:
collection_1和collection_2。此外,还有一个名为bob的 Collection 别名,它原本分配给collection_1:-
collection_1的别名 = ["bob"] -
collection_2的别名 = []
调用
alter_alias("collection_2", "bob")后:-
collection_1的别名 = [] -
collection_2的别名 = ["bob"]
-
-
timeout (float | None)
此操作的超时时长。
将其设置为 None 表示当收到任意响应或发生任何错误时,此操作即超时。
返回类型:
NoneType
返回值:
None
异常:
-
MilvusException
当此操作期间发生任何错误时,将引发此异常,尤其是在指定的别名不存在时。
示例
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 two collections
client.create_collection(collection_name="test_collection_1", dimension=5)
client.create_collection(collection_name="test_collection_2", dimension=5)
# 3. Create an alias for the collection
client.create_alias(collection_name="test_collection_1", alias="test")
# 4. Reassign the alias to the other collection
client.alter_alias(collection_name="test_collection_2", alias="test")