REST Resource: projects.databases.indexes

Ресурс: Индекс

Определение индекса.

JSON-представление 
{
  "name": string,
  "collectionId": string,
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Поля
name

string

Имя ресурса индекса. Только вывод.

collectionId

string

Идентификатор коллекции, к которой применяется этот индекс. Необходимый.

fields[]

object ( IndexField )

Поля для индексирования.

state

enum ( State )

Состояние индекса. Только вывод.

ИндексФилд

Поле индекса.

JSON-представление 
{
  "fieldPath": string,
  "mode": enum (Mode)
}
Поля
fieldPath

string

Путь поля. Должен соответствовать спецификации пути к полю, описанной в [google.firestore.v1beta1.Document.fields][fields]. Специальное поле path __name__ может использоваться само по себе или в конце пути. __type__ можно использовать только в конце пути.

mode

enum ( Mode )

Режим поля.

Режим

Режим определяет, как индексируется поле.

Перечисления
MODE_UNSPECIFIED Режим не указан.
ASCENDING Значения поля индексируются для поддержки упорядочивания в порядке возрастания, а также запроса по <, >, <=, >= и =.
DESCENDING Значения поля индексируются для поддержки упорядочивания в порядке убывания, а также запроса по <, >, <=, >= и =.
ARRAY_CONTAINS Значения массива поля индексируются для поддержки членства с помощью запросов ARRAY_CONTAINS.

Состояние

Состояние индекса. Во время создания индекса индекс будет находиться в состоянии CREATING . Если индекс создан успешно, он перейдет в состояние READY . Если индекс не может быть создан, он перейдет в состояние ERROR .

Перечисления
STATE_UNSPECIFIED Состояние не указано.
CREATING Индекс создается. Для индекса выполняется активная длительная операция. Индекс обновляется при написании документа. Могут существовать некоторые индексные данные.
READY Индекс готов к использованию. Индекс обновляется при написании документа. Индекс полностью заполняется из всех сохраненных документов, к которым он применяется.
ERROR Индекс создавался, но что-то пошло не так. Для индекса нет активных длительных операций, а последняя завершенная длительная операция завершилась неудачно. Индекс не обновляется при написании документа. Могут существовать некоторые индексные данные.

Методы

create

 Создает указанный индекс.

delete

 Удаляет индекс.

get

 Получает индекс.

list

 Перечисляет индексы, соответствующие указанным фильтрам.