REST Resource: projects.databases.indexes

Recurso: Index

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)

Es el estado del índice. Solo salida.

IndexField

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 del campo que se describe en [google.firestore.v1beta1.Document.fields][fields]. La ruta de campo especial __name__ la 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.

Moda

El modo determina cómo se indexa un campo.

Enumeradores
MODE_UNSPECIFIED El modo no está especificado.
ASCENDING Los valores del campo se indexan para admitir la secuencia en orden ascendente y también consultar por <, >, <=, >= y =.
DESCENDING Los valores del campo se indexan de manera que se admitan la secuencia en orden descendente y también se consultan por <, >, <=, >= y =.
ARRAY_CONTAINS Los valores del array del campo se indexan para admitir la membresía mediante consultas ARRAY_CONTAINS.

Estado

Es el estado de un índice. Durante la creación del índice, este tendrá el estado CREATING. Si el índice se creó correctamente, pasará al estado READY. Si no se puede crear el índice, pasará al estado ERROR.

Enumeradores
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 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 propaga por completo 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 la última operación de larga duración finalizada falló. 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

 Enumera los índices que coinciden con los filtros especificados.