listIndexes()

Addedv2.4.xModifiedv3.0.x

This operation lists the indexes of a specific collection

await milvusClient.listIndexes(data)

Request Syntax

await milvusClient.listIndexes({
   db_name: string,
   collection_name: string,
   field_name?: string,
   index_name?: 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.

• field_name (string) -

  The name of an existing field in the collection.

• index_name (string) -

  The name of the index to describe.

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

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

{
    indexes: string[],
    status:  ResStatus
}

PARAMETERS:

• indexes (string[]) - A list of index names defined on the requested collection.

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