StructuredQuery

{
  "select": {
    object (Projection)
  },
  "from": [
    {
      object (CollectionSelector)
    }
  ],
  "where": {
    object (Filter)
  },
  "orderBy": [
    {
      object (Order)
    }
  ],
  "startAt": {
    object (Cursor)
  },
  "endAt": {
    object (Cursor)
  },
  "offset": integer,
  "limit": integer
}

object ( Projection )

Subconjunto opcional de los campos a devolver.

Esto actúa como DocumentMask sobre los documentos devueltos por una consulta. Cuando no está configurado, se supone que la persona que llama quiere que se le devuelvan todos los campos.

object ( CollectionSelector )

Las colecciones a consultar.

object ( Filter )

El filtro a aplicar.

object ( Order )

El orden que se aplicará a los resultados de la consulta.

Firestore permite a las personas que llaman proporcionar un pedido completo, un pedido parcial o ningún pedido en absoluto. En todos los casos, Firestore garantiza un pedido estable a través de las siguientes reglas:

• orderBy es necesario para hacer referencia a todos los campos utilizados con un filtro de desigualdad.
• Todos los campos que deben estar en orderBy pero que aún no están presentes se agregan en el orden lexicográfico del nombre del campo.
• Si no se especifica una orden en __name__ , se agrega de forma predeterminada.

Los campos se añaden con la misma dirección de clasificación que el último orden especificado, o 'ASCENDENTE' si no se especificó ningún orden. Por ejemplo:

• ORDER BY a se convierte en ORDER BY a ASC, __name__ ASC
• ORDER BY a DESC se convierte en ORDER BY a DESC, __name__ DESC
• WHERE a > 1 se convierte en WHERE a > 1 ORDER BY a ASC, __name__ ASC
• WHERE __name__ > ... AND a > 1 se convierte WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

object ( Cursor )

Un prefijo potencial de una posición en el conjunto de resultados para iniciar la consulta.

El orden del conjunto de resultados se basa en la cláusula ORDER BY de la consulta original.

SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;

Los resultados de esta consulta están ordenados por (b ASC, __name__ ASC) .

Los cursores pueden hacer referencia al orden completo o a un prefijo de la ubicación, aunque no pueden hacer referencia a más campos que los que se encuentran en el ORDER BY proporcionado.

Siguiendo con el ejemplo anterior, adjuntar los siguientes cursores de inicio tendrá un impacto variable:

• START BEFORE (2, /k/123) : inicie la consulta justo antes a = 1 AND b > 2 AND __name__ > /k/123 .
• START AFTER (10) : inicie la consulta justo después a = 1 AND b > 10 .

A diferencia de OFFSET , que requiere escanear los primeros N resultados para omitir, un cursor de inicio permite que la consulta comience en una posición lógica. No es necesario que esta posición coincida con un resultado real; escaneará hacia adelante desde esta posición para encontrar el siguiente documento.

Requiere:

• El número de valores no puede ser mayor que el número de campos especificados en la cláusula ORDER BY .

object ( Cursor )

Un prefijo potencial de una posición en el conjunto de resultados en la que finalizar la consulta.

Esto es similar a START_AT pero controla la posición final en lugar de la posición inicial.

Requiere:

• El número de valores no puede ser mayor que el número de campos especificados en la cláusula ORDER BY .

integer

La cantidad de documentos que se deben omitir antes de devolver el primer resultado.

Esto se aplica después de las restricciones especificadas por WHERE , START AT y END AT pero antes de la cláusula LIMIT .

Requiere:

• El valor debe ser mayor o igual a cero si se especifica.

integer

El número máximo de resultados que se devolverán.

Se aplica después de todas las demás restricciones.

Requiere:

• El valor debe ser mayor o igual a cero si se especifica.