getFlushState()

This operation returns the flush status of a specific segment.

JavaScript

await milvusClient.getFlushState(data)

Milvus automatically flushes data into persistent storage at intervals. You are advised to rely on this automatic data persistence mechnism.

Request Syntax

JavaScript

await milvusClient.getFlushState({
    segment_ids: number[],
    timeout?: number
})

PARAMETERS:

• segment_ids (number[]) -

  [REQUIRED]

  A list of the target segment IDs.

• 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<GetFlushStateResponse>

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

JavaScript

{
    flushed: boolean,
    status:  ResStatus
}

PARAMETERS:

• flushed (boolean) - Whether all targeted segments are flushed to persistent storage. It is true when every requested segment ID is sealed and persisted, otherwise false.

• 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

JavaScript

const milvusClient = new MilvusClient({
    address: 'localhost:19530',
    token: 'root:Milvus',
});
const flushState = await milvusClient.getFlushState({
    segmentIDs: [1,2,3,4],
});