Skip to main content

DropAlias()

This operation drops an alias.

c++
Status DropAlias(const DropAliasRequest& request)

Request Syntax

c++
auto request = DropAliasRequest()
.WithDatabaseName(db_name)
.WithAlias(alias);

REQUEST METHODS:

  • WithDatabaseName(const std::string& db_name)

    Sets the target database name.

  • WithAlias(const std::string& alias)

    Sets the name of the alias.

RETURNS:

Status

Check status.IsOk() to confirm success.

EXCEPTIONS:

  • StatusCode

    Check status.Code() and status.Message() for error details.

Example

c++
#include "milvus/MilvusClientV2.h"
auto client = milvus::MilvusClientV2::Create();

milvus::ConnectParam connect_param{"YOUR_CLUSTER_ENDPOINT", "YOUR_CLUSTER_TOKEN"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}

status = client->DropAlias(
milvus::DropAliasRequest()
.WithAlias("my_alias"));
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
Minimum SDK versionv2.6.x
Ctrl I