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 de recurso del índice. Solo salida.

collectionId

string

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

fields[]

object ( IndexField )

Los campos para indexar.

state

enum ( State )

El estado del índice. Solo salida.

IndexField

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 la ruta del campo descrita en [google.firestore.v1beta1.Document.fields] [fields]. La ruta de campo especial __name__ puede usarse sola o al final de una ruta. __type__ se puede usar solo 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 consultar por <,>, <=,> = y =.
DESCENDING Los valores del campo están indexados para admitir la secuenciación en orden descendente y también consultar por <,>, <=,> = y =.
ARRAY_CONTAINS Los valores de la matriz del campo están indexados para admitir la pertenencia mediante consultas ARRAY_CONTAINS.

Expresar

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

Enumeraciones
STATE_UNSPECIFIED El estado no está especificado.
CREATING Se está creando el índice. Hay una operación activa de larga duración para el índice. El índice se actualiza al escribir un documento. Pueden existir algunos datos de índice.
READY El índice está listo para usarse. 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 de ejecución prolongada activa para el índice y la operación de ejecución prolongada finalizada más recientemente falló. El índice no se actualiza al escribir un documento. Pueden existir algunos datos de índice.

Métodos

create

Crea el índice especificado.

delete

Elimina un índice.

get

Obtiene un índice.

list

Muestra los índices que coinciden con los filtros especificados.