createAlias()

This operation creates an alias for an existing collection.

public void createAlias(CreateAliasReq request)

Request Syntax

createAlias(CreateAliasReq.builder()
    .alias(String alias)
    .collectionName(String collectionName)
    .build()
)

BUILDER METHODS:

• alias(String alias)

  The alias of the collection. Before this operation, ensure that the alias does not already exist. If it does, exceptions will occur.

  what is a collection alias?

  A collection alias is an additional name for a collection. Collection aliases are useful when you want to switch your application to a new collection without any changes to your code.

  In Milvus, a collection alias is a globally unique identifier. One alias can only be assigned to exactly one collection. Conversely, a collection can have multiple aliases.

  Below is an example of reassigning the alias of one collection to another:

  Suppose there are two collections: collection_1 and collection_2. There is also a collection alias named bob, which was originally assigned to collection_1:

  • collection_1's alias = [“bob”]

  • collection_2's alias = []

  After calling the alterAlias function with the parameters collection_2 and bob:

  • collection_1's alias = []

  • collection_2's alias = [“bob”]

• collectionName(String collectionName)

  The name of the collection to create an alias for.

RETURNS:

void

EXCEPTIONS:

• MilvusClientExceptions

  This exception will be raised when any error occurs during this operation.

Example

// create a alias "test_alias" for collection "test"
CreateAliasReq createAliasReq = CreateAliasReq.builder()
        .collectionName("test")
        .alias("test_alias")
        .build();
client.createAlias(createAliasReq);