Compact

This operation triggers compaction to merge small data segments into larger ones for better performance.

go

func (c *Client) Compact(ctx context.Context, option CompactOption, callOptions ...grpc.CallOption) (int64, error)

Request Syntax

Creates the request for Compact().

go

option := milvusclient.NewCompactOption(collectionName)

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

PARAMETERS:

• collectionName (string) -

  [REQUIRED]

  The name of the target collection.

BUILDER METHODS:

• NewCompactOption(collectionName string)

  Creates the request for Compact().

RETURN TYPE:

int64, error

RETURNS:

The numeric result value. Returns an error if the operation fails.

PARAMETERS:

• result (int64) -

  The int64 value returned by Compact().

ERROR HANDLING:

• error

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

Example

Demonstrates Compact() usage.

go

import (
	"context"
	"fmt"

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

ctx, cancel := context.WithCancel(context.Background())
defer cancel()

collectionName := `customized_setup_1`

cli, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
	Address: milvusAddr,
})
if err != nil {
	// handle err
}

compactID, err := cli.Compact(ctx, milvusclient.NewCompactOption(collectionName))
if err != nil {
	// handle err
}
fmt.Println(compactID)