milvus-logo
LFAI
< Docs
  • Node

getIndexState()

This method monitors the index building progress and displays the total number of rows as well as the number of indexed rows.

Example

import { MilvusClient } from "@zilliz/milvus2-sdk-node";

new milvusClient(MILUVS_ADDRESS).getIndexState({
  collection_name: "my_collection",
});

Response

// getIndexState returns
{
  status: { error_code: 'Success', reason: '' },
  state: 'Finished',
  fail_reason: ''
}

Parameters

ParametersDescriptionType
collection_nameCollection nameString
field_name?Name of the field to build index onString
index_name?Name of the index to checkString
timeout?This parameter is used to specify the length of time, in milliseconds, that the RPC (Remote Procedure Call) is allowed to run. If no value is provided, the default is undefined.Number