REST Resource: projects.databases.indexes

Recurso: Índice

Una definición de índice.

Representación JSON
{
  "name": string,
  "collectionId": string,
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Campos
name

string

El nombre del recurso del índice. Sólo salida.

collectionId

string

El ID de colección al que se aplica este índice. Requerido.

fields[]

object ( IndexField )

Los campos a indexar.

state

enum ( State )

El estado del índice. Sólo salida.

Campo de índice

Un campo de un índice.

Representación JSON
{
  "fieldPath": string,
  "mode": enum (Mode)
}
Campos
fieldPath

string

El camino del campo. Debe coincidir con la especificación de ruta de campo descrita por [google.firestore.v1beta1.Document.fields][fields]. La ruta del campo especial __name__ se puede usar sola o al final de una ruta. __type__ solo se puede utilizar al final de la ruta.

mode

enum ( Mode )

El modo del campo.

Modo

El modo determina cómo se indexa un campo.

Enumeraciones
MODE_UNSPECIFIED El modo no está especificado.
ASCENDING Los valores del campo están indexados para admitir la secuenciación en orden ascendente y también la consulta por <, >, <=, >= y =.
DESCENDING Los valores del campo están indexados para admitir la secuenciación en orden descendente y también la consulta por <, >, <=, >= y =.
ARRAY_CONTAINS Los valores de la matriz del campo están indexados para admitir la membresía mediante consultas ARRAY_CONTAINS.

Estado

El estado de un índice. Durante la creación del índice, un índice estará en el estado CREATING . Si el índice se crea correctamente, pasará al estado READY . Si no se puede crear el índice, pasará al estado ERROR .

Enumeraciones
STATE_UNSPECIFIED El estado no se especifica.
CREATING El índice se está creando. Hay una operación activa de larga duración para el índice. El índice se actualiza al escribir un documento. Es posible que existan algunos datos de índice.
READY El índice está listo para ser utilizado. El índice se actualiza al escribir un documento. El índice se completa completamente con todos los documentos almacenados a los que se aplica.
ERROR Se estaba creando el índice, pero algo salió mal. No hay ninguna operación activa de larga duración para el índice y la operación de larga duración finalizada más recientemente falló. El índice no se actualiza al escribir un documento. Es posible que existan algunos datos de índice.

Métodos

create

 Crea el índice especificado.

delete

 Elimina un índice.

get

 Obtiene un índice.

list

 Enumera los índices que coinciden con los filtros especificados.