Collection Alias
Milvus supports specifying a unique alias for a collection.
A collection alias is globally unique, hence you cannot assign the same alias to different collections. However, you can assign multiple aliases to one collection.
The following example is based on the alias publication
.
Create a collection alias
Specify an an alias for a collection.
from pymilvus import utility
utility.create_alias(
collection_name = "book",
alias = "publication"
)
await milvusClient.collectionManager.createAlias({
collection_name: "book",
alias: "publication",
});
create alias -c book -a publication
Parameter
Description
collection_name
Name of the collection to create alias on.
alias
Collection alias to create.
Parameter
Description
collection_name
Name of the collection to create alias on.
alias
Collection alias to create.
Option
Description
-c
Name of the collection to create alias on.
-a
Collection alias to create.
-A (Optional)
Flag to transfer the alias to a specified collection.
Drop a collection alias
Drop a specified alias.
from pymilvus import utility
utility.drop_alias(
alias = "publication"
)
await milvusClient.collectionManager.dropAlias({
alias: "publication",
});
delete alias -c book -a publication
Parameter
Description
alias
Collection alias to drop.
Parameter
Description
alias
Collection alias to drop.
Option
Description
-c
Name of the collection to drop alias on.
-a
Collection alias to drop.
Alter a collection alias
Alter an existing alias to another collection.
from pymilvus import utility
utility.alter_alias(
collection_name = "book",
alias = "publication"
)
await milvusClient.collectionManager.alterAlias({
collection_name: "book",
alias: "publication",
});
create alias -c book -A -a publication
Parameter
Description
collection_name
Name of the collection to alter alias to.
alias
Collection alias to alter.
Parameter
Description
collection_name
Name of the collection to alter alias to.
alias
Collection alias to alter.
Option
Description
-c
Name of the collection to alter alias to.
-a
Collection alias to alter.
-A
Flag to transfer the alias to a specified collection.
Limits
Feature
Maximum limit
Length of an alias
255 characters
What's next
Learn more basic operations of Milvus:
Explore API references for Milvus SDKs: