Recurso: Índice
Uma definição de índice.
Representação JSON | |
---|---|
{ "name": string, "collectionId": string, "fields": [ { object ( |
Campos | |
---|---|
name | O nome do recurso do índice. Somente saída. |
collectionId | O ID da coleção à qual este índice se aplica. Obrigatório. |
fields[] | Os campos a serem indexados. |
state | O estado do índice. Somente saída. |
IndexField
Um campo de um índice.
Representação JSON | |
---|---|
{
"fieldPath": string,
"mode": enum ( |
Campos | |
---|---|
fieldPath | O caminho do campo. Deve corresponder à especificação do caminho do campo descrita por [google.firestore.v1beta1.Document.fields] [campos]. O caminho de campo especial |
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 modo a oferecer suporte a sequenciamento em ordem crescente e também consulta por <,>, <=,> = e =. |
DESCENDING | Os valores do campo são indexados de modo a oferecer suporte ao sequenciamento em ordem decrescente e também à consulta por <,>, <=,> = e =. |
ARRAY_CONTAINS | Os valores da matriz do campo são indexados para oferecer suporte à 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 fará a transição 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 ao escrever um documento. Podem existir alguns dados de índice. |
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 de longa execução ativa 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. Podem existir alguns dados de índice. |
Métodos | |
---|---|
| Cria o índice especificado. |
| Exclui um índice. |
| Obtém um índice. |
| Lista os índices que correspondem aos filtros especificados. |