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

Sólo salida. Un nombre definido por el servidor para este índice. La forma de este nombre para índices compuestos será: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Para índices de campo único, este campo estará vacío.

queryScope

enum ( QueryScope )

Los índices con un alcance de consulta de colección especificado permiten consultas en una colección que es hija de un documento específico, especificada 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 en todas las colecciones que descienden de un documento específico, especificadas en el momento de la consulta y que tienen la misma identificación de colección que este índice.

fields[]

object ( IndexField )

Los campos soportados por este índice.

Para índices compuestos, siempre son 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 no se especificó __name__ 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 (a menos que se especifique explícitamente).

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

state

enum ( State )

Sólo salida. El estado de servicio del índice.

Métodos

create

 Crea un índice compuesto.

delete

 Elimina un índice compuesto.

get

 Obtiene un índice compuesto.

list

 Enumera índices compuestos.