REST Resource: projects.databases.indexes

Recurso: Index

Uma definição de índice.

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

string

O nome do recurso do índice. Apenas saída.
collectionId

string

O ID da coleção ao qual este índice se aplica. Obrigatório.
fields[]

object (IndexField)

Os campos a serem indexados.
state

enum (State)

O estado do índice. Apenas saída.

IndexField

Um campo de um índice.

Representação JSON 
{
  "fieldPath": string,
  "mode": enum (Mode)
}
Campos
fieldPath

string

Caminho do campo. Precisa corresponder à especificação do caminho do campo descrita por [google.firestore.v1beta1.Document.fields][fields]. O caminho de campo especial __name__ pode ser usado sozinho ou no final de um caminho. __type__ só pode ser usado no fim do caminho.
mode

enum (Mode)

O modo do campo.

Modo

O modo determina como um campo é indexado.

Enums
MODE_UNSPECIFIED O modo não foi especificado.
ASCENDING Os valores do campo são indexados para oferecer suporte ao sequenciamento em ordem crescente e também consultar por <, >, <=, >= e =.
DESCENDING Os valores do campo são indexados para oferecer suporte ao sequenciamento em ordem decrescente e também consultar por <, >, <=, >= e =.
ARRAY_CONTAINS Os valores da matriz do campo são indexados para permitir a associação usando consultas ARRAY_CONTAINS.

Estado

O estado de um índice. Durante a criação, um índice estará no estado CREATING. Se o índice for criado, ele vai fazer a transição para o estado READY. Se não for possível criar o índice, ele vai passar para o estado ERROR.

Enums
STATE_UNSPECIFIED O estado não foi especificado.
CREATING O índice está sendo criado. Há uma operação ativa de longa duração para o índice. O índice é atualizado durante a gravação de um documento. Pode haver alguns dados de índice.
READY O índice está pronto para ser usado. O índice é atualizado durante a gravação de um documento. O índice é totalmente preenchido com todos os documentos armazenados aos quais ele se aplica.
ERROR O índice estava sendo criado, mas algo deu errado. Não há uma operação de longa duração ativa para o índice, e a operação de longa duração concluída mais recentemente falhou. O índice não é atualizado durante a gravação de um documento. Pode haver alguns dados de índice.

Métodos

create

 Cria o índice especificado.

delete

 Exclui um índice.

get

 Recebe um índice.

list

 Lista os índices que correspondem aos filtros especificados.