Skip to main content

ListUsers

This operation lists all users in the Milvus instance.

go
func (c *Client) ListUsers(ctx context.Context, opt ListUserOption, callOpts ...grpc.CallOption) ([]string, error)

Request Syntax​

Creates the request for ListUsers().

go
option := milvusclient.NewListUserOption()

users, err := client.ListUsers(ctx, option)

BUILDER METHODS:

  • NewListUserOption()

    Creates the request for ListUsers().

RETURN TYPE:

[]string, error

RETURNS:

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

PARAMETERS:

  • result ([]string) -

    The []string value returned by ListUsers().

ERROR HANDLING:

  • error

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

Example​

Demonstrates ListUsers() 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)

users, err := cli.ListUsers(ctx, milvusclient.NewListUserOption())
if err != nil {
// handle error
}
fmt.Println(users)
Minimum SDK versionv3.0.x
Was this page helpful?