ListCollections

This operation lists all collections in the current database.

go

func (c *Client) ListCollections(ctx context.Context, option ListCollectionOption, callOptions ...grpc.CallOption) (collectionNames []string, err error)

Request Syntax

Creates the request for ListCollections().

go

option := milvusclient.NewListCollectionOption()

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

BUILDER METHODS:

• NewListCollectionOption()

  Creates the request for ListCollections().

RETURN TYPE:

collectionNames []string, err error

RETURNS:

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

PARAMETERS:

• result (collectionNames []string) -

  The collectionNames []string value returned by ListCollections().

ERROR HANDLING:

• error

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

Example

Demonstrates ListCollections() usage.

go

import (
	"context"
	"fmt"
	"log"

	"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 {
	log.Fatal("failed to connect to milvus server: ", err.Error())
}

defer cli.Close(ctx)

collectionNames, err := cli.ListCollections(ctx, milvusclient.NewListCollectionOption())
if err != nil {
	// handle error
}

fmt.Println(collectionNames)