milvus-logo

getIndexState()

This method checks if the index building is completed or not.

Invocation

new milvusClient(MILUVS_ADDRESS).collectionManager.getIndexState(
  GetIndexStateReq
);

Parameter

GetIndexStateReq

ParameterDescriptionTypeRequired
collection_nameCollection nameStringTrue
field_nameName of the field to build index onStringFalse
index_nameName of the index to checkStringFalse
timeoutAn optional duration of time in millisecond to allow for the RPC. Default is undefinedNumberFalse

Example

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

Return

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