ListAliases

This operation returns the aliases of a specified collection.

go

func (c *Client) ListAliases(ctx context.Context, option ListAliasesOption, callOptions ...grpc.CallOption) ([]string, error)

Request Syntax

Creates the request for ListAliases().

go

option := milvusclient.NewListAliasesOption(collectionName)

result, err := client.ListAliases(ctx, option)

PARAMETERS:

• collectionName (string) -

  [REQUIRED]

  The name of the target collection.

BUILDER METHODS:

• NewListAliasesOption(collectionName string)

  Creates options to list the aliases of a collection. collectionName specifies the collection.

RETURN TYPE:

[]string, error

RETURNS:

A list of alias names for the collection. Returns an error if the operation fails.

PARAMETERS:

• result ([]string) -

  The []string value returned by ListAliases().

ERROR HANDLING:

• error

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

Example

Demonstrates ListAliases() usage.

go

import (
	"context"
	"fmt"

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

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

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

result, err := cli.ListAliases(ctx, milvusclient.NewListAliasesOption("books"))
if err != nil {
	// handle error
}
fmt.Println(result)