REST Resource: projects.databases.collectionGroups.indexes

Recurso: Índice

Os índices do Cloud Firestore permitem consultas simples e complexas em documentos em um banco de dados.

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

string

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

queryScope

enum ( QueryScope )

Os índices com um escopo de consulta de coleção especificado permitem consultas em uma coleção que é filho de um documento específico, especificado no momento da consulta e que possui 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 possuem o mesmo ID de coleção que esse índice.

apiScope

enum ( ApiScope )

O escopo da API compatível com este índice.

fields[]

object ( IndexField )

Os campos suportados por este índice.

Para índices compostos, isso requer um mínimo de 2 e um máximo de 100 campos. A última entrada do campo é sempre para o caminho do campo __name__ . Se, na criação, __name__ não foi especificado como ú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 ASCENDENTE (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 )

Somente saída. O estado de veiculação do índice.

Métodos

create

 Cria um índice composto.

delete

 Exclui um índice composto.

get

 Obtém um índice composto.

list

 Lista índices compostos.