Index Object


Properties
namestringminLength 1maxLength 128

Name of the index.


fieldsArray <Field>minItems 1maxItems 3

Fields for which the index is defined.

Max: 3 fields (for a unique index: 1 field)


statusstringRead-only

Current status of the index.

  • BUILDING: Index creation is in progress.
  • ACTIVE: Index has been successfully created and can be used in queries.
  • DROPPING: Index is in the process of being dropped.
  • DROPPED: Index has been dropped successfully.
  • FAILED: Index creation has failed.
  • INVALID: Index contains incorrectly indexed data.

failureFailure

Contains details about the reasons for failure when status is FAILED.


uniqueboolean

Whether the index enforces uniqueness of values in the field for which it is defined. If true, the index can have only one field.

Default: false


caseInsensitiveboolean

Whether the index ignores case.

Default: false

Did this help?