milvus-logo

create_alias()

This method specifies an alias for a collection. Alias cannot be duplicated. Same alias cannot be assigned to different collections. Instead, you can specify multiple aliases for each collection.

Invocation

create_alias(collection_name, alias, timeout=None, using='default')

Parameters

ParameterDescriptionTypeRequired
collection_nameName of the collection to create alias for.StringTrue
aliasAlias to create.StringTrue
timeoutAn optional duration of time in seconds to allow for the RPC. If it is set to None, the client keeps waiting until the server responds or error occurs.FloatFalse
usingMilvus connection used to create the alias.StringFalse

Return

No return.

Raises

  • CollectionNotExistException: error if the collection does not exist.
  • BaseException: error if failed to create the alias.