Skip to main content

DropDatabaseProperties

This operation removes specified properties from a database.

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

Request Syntax​

Creates the request for DropDatabaseProperties().

go
option := milvusclient.NewDropDatabasePropertiesOption(dbName, propertyKeys)

err := client.DropDatabaseProperties(ctx, option)

PARAMETERS:

  • dbName (string) -

    [REQUIRED]

    The name of the database.

  • propertyKeys (...string) -

    [REQUIRED]

    The property keys.

BUILDER METHODS:

  • NewDropDatabasePropertiesOption(dbName string, propertyKeys ...string)

    Creates the request for DropDatabaseProperties().

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

go
import (
"context"

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

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.DropDatabaseProperties(ctx, milvusclient.NewDropDatabasePropertiesOption("my_database", common.DatabaseReplicaNumber))
if err != nil {
// handle err
}
Minimum SDK versionv3.0.x
Was this page helpful?