REST Resource: projects.databases.collectionGroups.indexes

Recurso: Índice

Los índices de Cloud Firestore permiten consultas simples y complejas en documentos en una base de datos.

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

string

Solo salida. Un nombre definido por el servidor para este índice. La forma de este nombre para los índices compuestos será: projects/{project_id}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Para índices de un solo campo, este campo estará vacío.

queryScope

enum ( QueryScope )

Los índices con un alcance de consulta de colección especificado permiten consultas contra una colección que es secundaria de un documento específico, especificado en el momento de la consulta, y que tiene el mismo ID de colección.

Los índices con un alcance de consulta de grupo de colección especificado permiten consultas contra todas las colecciones que descienden de un documento específico, especificado en el momento de la consulta, y que tienen el mismo ID de colección que este índice.

fields[]

object ( IndexField )

Los campos admitidos por este índice.

Para índices compuestos, esto siempre es 2 o más campos. La última entrada de campo es siempre para la ruta del campo __name__ . Si, en el momento de la creación, __name__ no se especificó como último campo, se agregará automáticamente con la misma dirección que la del último campo definido. Si el campo final en un índice compuesto no es direccional, el __name__ se ordenará ascendente (menos que se especifique explícitamente).

Para índices de un solo campo, siempre será exactamente una entrada con una ruta de campo igual a la ruta de campo del campo asociado.

state

enum ( State )

Solo salida. El estado de publicación del índice.

Métodos

create

Crea un índice compuesto.

delete

Elimina un índice compuesto.

get

Obtiene un índice compuesto.

list

Muestra índices compuestos.