create_alias()
Near Deprecation此操作为现有 Collection 创建别名。
请求语法
python
create_alias(
collection_name: str,
alias: str,
using: str,
timeout: float | None
)
参数:
-
collection_name (str) -
[必需]
要为其创建别名的 Collection 名称。
-
alias (str) -
[必需]
Collection 的别名。在执行此操作之前,请确保该别名尚不存在。如果已存在,则会发生异常。
Note什么是 Collection 别名?
Collection 别名是 Collection 的附加名称。当您希望将应用程序切换到新的 Collection 且无需修改代码时,Collection 别名会很有用。
在 中,Collection 别名是全局唯一标识符。一个别名只能分配给一个 Collection。反之,一个 Collection 可以有多个别名。
假设有一个 Collection:
collection_1。您可以通过调用create_alias("collection_1", "bob")和create_alias("collection_1", "tom"),为此 Collection 分配两个不同的别名(bob和tom)。 -
using (str) -
所使用连接的别名。
默认值为 default,表示此操作使用默认连接。
-
timeout (float | None)
此操作的超时时长。将其设置为 None 表示当收到任何响应或发生任何错误时,此操作即超时。
返回类型:
NoneType
返回值:
None
异常:
-
MilvusException
当此操作期间发生任何错误时,将引发此异常,尤其是在您将
alias设置为现有别名时。 -
BaseException
当此操作失败时,将引发此异常。
示例
python
from pymilvus import connections, Collection, utility
# Connection to YOUR_CLUSTER_ENDPOINT
connections.connect()
# Get an existing collection
collection_1 = Collection("collection_1")
# Create an alias for collection_1
utility.create_alias(collection_name="collection_1", alias="bob")
# List aliases for the collection
utility.list_aliases(collection_name="collection_1") # ['bob']
# Create another alias for collection_1
utility.create_alias(collection_name="collection_1", alias="tom")
# List aliases for the collection
utility.list_aliases(collection_name="collection_1") # ['bob', 'tom']
相关操作
以下操作与 create_alias() 相关: