Skip to main content

describe

Addedv0.1.x

This operation gets details of an index.

Synopsis​

zilliz index describe
--collection <value>
--index-name <value>
[--database <value>]
[--output <json | table | text | yaml | csv]
[--no-header]
[--query <value>]

Options​

  • --collection (string) -

    [REQUIRED]

    Indicates the collection name.

  • --index-name (string) -

    [REQUIRED]

    Indicates the index name.

  • --database (string) -

    Indicates the database name.

  • --output, -o (string) -

    Indicates the output format. Possible values:

    • json,

    • table,

    • text,

    • yaml,

    • csv.

  • --no-header (boolean) -

    Indicates whether to omit the header row when the output is set to table or csv.

  • --query, -q (string) -

    Indicates a JMESPath expression to filter output.

Example​

zilliz index describe --collection my_collection --index-name my_index