Skip to main content

UseDatabase

This operation switches the active database for the current client connection.

go
func (c *Client) UseDatabase(ctx context.Context, option UseDatabaseOption) error

Request Syntax​

Creates the request for UseDatabase().

go
option := milvusclient.NewUseDatabaseOption("my_database")

:= client.UseDatabase(ctx, option)

BUILDER METHODS:

  • NewUseDatabaseOption(dbName string)

    Creates the request for UseDatabase().

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 UseDatabase() usage.

go
import (
"context"

"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 err
}
defer cli.Close(ctx)

err = cli.UseDatabase(ctx, milvusclient.NewUseDatabaseOption("my_database"))
if err != nil {
// handle err
}
Minimum SDK versionv3.0.x
Was this page helpful?