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. Solo salida.
collectionId

string

El ID de colección al que se aplica este índice. Obligatorio.
fields[]

object (IndexField)

Los campos que se indexarán.
state

enum (State)

El estado del índice. Solo salida.

CampoÍndice

Es un campo de un índice.

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

string

La ruta del campo. Debe coincidir con la especificación de la ruta de acceso del campo que se describe en [google.firestore.v1beta1.Document.fields][fields]. La ruta de acceso de campo especial __name__ se puede usar sola o al final de una ruta de acceso. __type__ solo se puede usar al final de la ruta de acceso.
mode

enum (Mode)

El modo del campo.

Modo

El modo determina cómo se indexa un campo.

Enums
MODE_UNSPECIFIED El modo no está especificado.
ASCENDING Los valores del campo se indexan para admitir la secuenciación en orden ascendente y también consultar por <, >, <=, >= y =.
DESCENDING Los valores del campo se indexan para admitir la secuenciación en orden descendente y también consultar por <, >, <=, >= y =.
ARRAY_CONTAINS Los valores del array del campo están indexados para admitir la membresía mediante consultas de 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, cambiará al estado ERROR.

Enums
STATE_UNSPECIFIED El estado no se especifica.
CREATING Se está creando el índice. Hay una operación activa de larga duración para el índice. El índice se actualiza cuando se escribe un documento. Es posible que existan algunos datos de índice.
READY El índice está listo para usarse. El índice se actualiza cuando se escribe un documento. El índice se completa con todos los documentos almacenados a los que se aplica.
ERROR Se estaba creando el índice, pero se produjo un error. No hay una operación de larga duración activa para el índice y falló la operación de larga duración que finalizó más recientemente. El índice no se actualiza cuando se escribe un documento. Es posible que existan algunos datos de índice.

Métodos

create

 Crea el índice especificado.

delete

 Borra un índice.

get

 Obtiene un índice.

list

 Muestra una lista de los índices que coinciden con los filtros especificados.