REST Resource: projects.databases.collectionGroups.indexes

Recurso: Index

Com os índices do Cloud Firestore, é possível realizar consultas simples e complexas em documentos de um banco de dados.

Representação JSON 
{
  "name": string,
  "queryScope": enum (QueryScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Campos
name

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.
queryScope

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 este índice.
fields[]

object (IndexField)

Os campos suportados por este índice.

Para índices compostos, são sempre dois ou mais 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.
state

enum (State)

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

Métodos

create

 Cria um índice composto.

delete

 Exclui um índice composto.

get

 Recebe um índice composto.

list

 Lista os índices compostos.