Schema for information about an index.

Hierarchy

  • IndexInformation

Properties

ddoc: string

Design document ID including a _design/ prefix.

Schema for a json or text query index definition. Indexes of type text have additional configuration properties that do not apply to json indexes, these are:

  • default_analyzer - the default text analyzer to use * default_field - whether to index the text in all document fields and what analyzer to use for that purpose.
name: string

Index name.

partitioned?: boolean

Indicates if index is partitioned.

type: string

Schema for the type of an index.

Generated using TypeDoc