REST Resource: projects.databases.collectionGroups.indexes

{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}

string

Apenas saída. Um nome definido pelo servidor para este índice. A forma desse nome para índices compostos será: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id}. Para índices de campo único, esse campo estará vazio.

enum (QueryScope)

Os índices com um escopo de consulta de coleção especificado permitem fazer consultas em uma coleção que é filha de um documento específico, especificada no momento da consulta e que tem o mesmo ID de coleção.

Os índices com um escopo de consulta de grupo de coleções especificado permitem consultas em todas as coleções descendentes de um documento específico, especificado no momento da consulta e que têm o mesmo ID de coleção que o índice.

enum (ApiScope)

O escopo da API suportado por este índice.

object (IndexField)

Os campos suportados por este índice.

Para índices compostos, isso requer no mínimo 2 e no máximo 100 campos. A última entrada de campo é sempre para o caminho do campo __name__. Se, na criação, __name__ não tiver sido especificado como o último campo, ele será adicionado automaticamente com a mesma direção do último campo definido. Se o campo final em um índice composto não for direcional, o __name__ será ordenado ASCENDING (a menos que especificado explicitamente).

Para índices de campo único, será sempre exatamente uma entrada com um caminho de campo igual ao caminho do campo associado.

enum (State)

Apenas saída. O estado de exibição do índice.