Skip to main content

DropCollectionProperties

This operation removes specified properties from a collection.

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

Request Syntax​

Creates the request for DropCollectionProperties().

go
option := milvusclient.NewDropCollectionPropertiesOption(collection, propertyKeys)

err := client.DropCollectionProperties(ctx, option)

PARAMETERS:

  • collection (string) -

    [REQUIRED]

    The collection.

  • propertyKeys (...string) -

    [REQUIRED]

    The property keys.

BUILDER METHODS:

  • NewDropCollectionPropertiesOption(collection string, propertyKeys ...string)

    Creates the request for DropCollectionProperties().

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

go
import (
"context"
"log"

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

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)

err = cli.DropCollectionProperties(ctx, milvusclient.NewDropCollectionPropertiesOption("my_collection", common.CollectionTTLConfigKey))
if err != nil {
// handle error
}
Minimum SDK versionv3.0.x
Was this page helpful?