Flush()

This method flushes data into storage.

func (c *Client) Flush(ctx context.Context, option FlushOption, callOptions ...grpc.CallOption) (*FlushTask, error)

Request Parameters

Parameter	Description	Type
ctx	Context for the current call to work.	context.Context
option	Optional parameters of the methods.	FlushOption
callOptions	Optional parameters for calling the methods.	grpc.CallOption

FlushOption

This is an interface type. The flushOption struct types implement this interface type.

You can use the NewFlushOption function to get the concrete implementation.

NewFlushOption

The signature of this method is as follows:

func NewFlushOption(collName string) *flushOption

Parameter	Description	Type
collName	Name of the target collection.	string

FlushTask

The is a struct type. It provides the following methods.

Await

This method awaits the current flush task to complete. The signature is as follows:

func (t *FlushTask) Await(ctx context.Context) error

This method does not take any input parameters.

GetFlushStats

This method returns the statistics on the current flush tasks. The signature is as follows:

func (t *FlushTask) GetFlushStats() (segIDs []int64, flushSegIDs []int64, flushTs uint64, channelCheckpoints map[string]*msgpb.MsgPosition)

This method does not take any input parameters. The following table lists the values that return.

Parameter	Description	Type
segIDs	List of segment IDs.	[]int64
flushSegIDs	List of flush segment IDs.	[]int64
flushTs	Flush timestamp.	unit64
channelCheckpoints	Channel check points	map[string]*msgpb.MsgPosition

Return

*FlushTask

Example

collectionName := `customized_setup_1`

task, err := cli.Flush(ctx, milvusclient.NewFlushOption(collectionName))
if err != nil {
    // handle err
}

// wait flush done, you could choose to ignore this task to do async flush
err = task.Await(ctx)
if err != nil {
    // handle err
}