Skip to main content

DropAlias

This operation removes a collection alias.

go
func (c *Client) DropAlias(ctx context.Context, option DropAliasOption, callOptions ...grpc.CallOption) error

Request Syntax​

Creates the request for DropAlias().

go
option := milvusclient.NewDropAliasOption(alias)

err := client.DropAlias(ctx, option)

PARAMETERS:

  • alias (string) -

    [REQUIRED]

    The alias name to assign.

BUILDER METHODS:

  • NewDropAliasOption(alias string)

    Creates the request for DropAlias().

RETURN TYPE:

error

RETURNS:

Returns nil on success, or an error describing what went wrong.

ERROR HANDLING:

  • error

    The operation fails. Check err != nil for failure details.

Example​

Demonstrates DropAlias() usage.

go
import (
"context"

"github.com/milvus-io/milvus/client/v3/milvusclient"
)

ctx, cancel := context.WithCancel(context.Background())
defer cancel()

milvusAddr := "YOUR_CLUSTER_ENDPOINT"

cli, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
Address: milvusAddr,
})
if err != nil {
// handle error
}

err = cli.DropAlias(ctx, milvusclient.NewDropAliasOption("alice"))
if err != nil {
// handle error
}
Minimum SDK versionv3.0.x
Was this page helpful?