REST Resource: projects.databases.collectionGroups.indexes

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

Индексы Cloud Firestore позволяют выполнять простые и сложные запросы к документам в базе данных.

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

string

Только вывод. Определенное сервером имя для этого индекса. Форма этого имени для составных индексов будет следующей: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Для индексов с одним полем это поле будет пустым.

queryScope

enum ( QueryScope )

Индексы с указанной областью запроса коллекции позволяют выполнять запросы к коллекции, которая является дочерней по отношению к определенному документу, указанному во время запроса, и имеет тот же идентификатор коллекции.

Индексы с указанной областью запроса группы коллекций позволяют выполнять запросы ко всем коллекциям, происходящим из определенного документа, указанного во время запроса, и которые имеют тот же идентификатор коллекции, что и этот индекс.

apiScope

enum ( ApiScope )

Область API, поддерживаемая этим индексом.

fields[]

object ( IndexField )

Поля, поддерживаемые этим индексом.

Для составных индексов требуется минимум 2 и максимум 100 полей. Последняя запись поля всегда относится к пути к полю __name__ . Если при создании __name__ не было указано в качестве последнего поля, оно будет добавлено автоматически в том же направлении, что и последнее определенное поле. Если последнее поле в составном индексе не является направленным, __name__ будет упорядочено по возрастанию (если не указано иное).

Для индексов с одним полем это всегда будет ровно одна запись с путем к полю, равным пути к связанному полю.

state

enum ( State )

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

Методы

create

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

delete

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

get

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

list

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