REST Resource: projects.databases.indexes

Recurso: Índice

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. Somente saída.

collectionId

string

O ID da coleção à qual esse índice se aplica. Obrigatório.

fields[]

object ( IndexField )

Os campos a serem indexados.

state

enum ( State )

O estado do índice. Somente saída.

CampoIndex

Um campo de um índice.

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

string

O caminho do campo. Deve corresponder à especificação do caminho do campo descrita por [google.firestore.v1beta1.Document.fields][fields]. O campo especial path __name__ pode ser usado sozinho ou no final de um caminho. __type__ pode ser usado apenas no final do caminho.

mode

enum ( Mode )

O modo do campo.

Modo

O modo determina como um campo é indexado.

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

Estado

O estado de um índice. Durante a criação do índice, um índice estará no estado CREATING . Se o índice for criado com sucesso, ele fará a transição para o estado READY . Se o índice não puder ser criado, ele passará para o estado ERROR .

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

Métodos

create

 Cria o índice especificado.

delete

 Exclui um índice.

get

 Obtém um índice.

list

 Lista os índices que correspondem aos filtros especificados.