flush()

This operation manually seals a segment and persists the data on disk. It is recommended that this operation be called after all the data has been inserted into a collection.

await milvusClient.flush(data)

Request Syntax

await milvusClient.flush({
    db_name?: string,
    collection_names: string[],
    timeout?: number
})

PARAMETERS:

• db_name (string) -

  The name of the target database to which the target collections belong.

• collection_names (string[]) -

  [REQUIRED]

  A list of the target collection names.

• timeout (number)

  The timeout duration for this operation.

  Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.

RETURNS Promise

This method returns a promise that resolves to a FlushResult object.

{
    coll_segIDs: Record<string, { data: number[] }>,
    status:  ResStatus
}

PARAMETERS:

• coll_segIDs (Record) - A mapping from collection name to the segment IDs that were sealed by this flush. Use the returned IDs with getFlushState() to confirm persistence.

• ResStatus A ResStatus object.

  • code (number) -

    A code that indicates the operation result. It remains 0 if this operation succeeds.

  • error_code (string | number) -

    An error code that indicates an occurred error. It remains Success if this operation succeeds.

  • reason (string) -

    The reason that indicates the reason for the reported error. It remains an empty string if this operation succeeds.

Example

const milvusClient = new MilvusClient({
    address: 'localhost:19530',
    token: 'root:Milvus',
});
const flushStatus = await milvusClient.flush({
    collection_names: ['my_collection'],
});