DescribeIndex()

This method describes the specified index by providing its detailed information.

func (c *Client) DescribeIndex(ctx context.Context, opt DescribeIndexOption, callOptions ...grpc.CallOption) (IndexDescription, error)

Request Parameters

Parameter	Description	Type
ctx	Context for the current call to work.	context.Context
opt	Optional parameters of the methods.	DescribeIndexOption
callOpts	Optional parameters for calling the methods.	grpc.CallOption

DescribeIndexOption

This is an interface type. The describeIndexOption struct type implements this interface type.

You can use the NewDescribeIndexOption() function to get the concrete implementation.

NewDescribeIndexOption()

The signature of this method is as follows:

func NewDescribeIndexOption(collectionName string, indexName string) *describeIndexOption

Parameter	Description	Type
collectionName	Name of the target collection.	string
indexName	Name of the target index.	string

IndexDescription

The IndexDescription struct type is as follows:

type IndexDescription struct {
    index.Index
    State            index.IndexState
    PendingIndexRows int64
    TotalRows        int64
    IndexedRows      int64
}

index.Index

This is an interface type. For details, refer to index.Index.

index.IndexState

Possible values are as follows:

Return

IndexDescription

Example

indexInfo, err := cli.DescribeIndex(ctx, milvusclient.NewDescribeIndexOption("my_collection", "my_index"))
if err != nil {
    // handle err
}
fmt.Println(indexInfo)