getLoadState()

This operation displays whether a specified collection or partition is loaded or not.

await milvusClient.getLoadState(data)

Request Syntax

await milvusClient.getLoadState({
   db_name: string,
   collection_name: string,
   partition_names?: string[],
   timeout?: number
 })

PARAMETERS:

• db_name (string) -

  The name of the database that holds the target collection.

• collection_name (string) -

  [REQUIRED]

  The name of a collection.

• partition_names (string[]) -

  The names of one or more partitions.

• timeout (number) -

  The timeout duration for this operation. Setting this to None indicates that this operation timeouts when any response returns or error occurs.

RETURNS Promise

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

{
    state: LoadState,
    status:  ResStatus
}

PARAMETERS:

• state (LoadState) - The current load state. Possible values are LoadStateNotExist, LoadStateNotLoad, LoadStateLoading, and LoadStateLoaded.

• 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 resStatus = await milvusClient.getLoadState({
   collection_name: 'my_collection',
 });