loadPartitionsSync()

This operation loads the data of specific partitions into memory. This is the synchronous function that helps to ensure that the specified partitions have been loaded.

await milvusClient.loadPartitionsSync(data)

Request Syntax

await milvusClient.loadPartitionsSync({ 
    db_name: string,
    collection_name: string,
    refresh?: boolean,
    replica_number?: number,
    resource_groups?: string[],
    timeout?: number
})

PARAMETERS:

• db_name (string) -

  The name of the database that holds the target collection.

• collection_name (string) -

  [REQUIRED]

  The name of an existing collection.

• partition_names (string[]) -

  [REQUIRED]

  A list of the names of the partitions to load.

• replica_number (number) -

  The number of replicas of the partition.

• resource_groups (string[]) -

  A list of the resource groups in the partition.

• 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 ResStatus object.

{
    code: number,
    error_code: string | number,
    reason: string
}

PARAMETERS:

• 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

new MilvusClient({
    address: 'localhost:19530',
    token: 'root:Milvus',
}).loadPartitionsSync({
    collection_name: 'my_collection',
    partition_names: ['my_partition'],
 });