describe

Addedv0.1.x

This operation gets details of a collection.

Synopsis

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

Options

• --name (string) -

  [REQUIRED]

  Indicates the collection name.

• --database (string) -

  Indicates the database name.

  If a cluster is configured using zilliz context set, the database it belongs automatically applies if this option is left unconfigured.

• --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 collection describe --name my_collection