StructuredQuery

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

object (Projection)

Subconjunto opcional de los campos que se mostrarán.

Esto actúa como un DocumentMask sobre los documentos que se muestran en una consulta. Cuando no se establece, supone que el llamador desea que se devuelvan todos los campos.

object (CollectionSelector)

Las colecciones que se consultarán.

object (Filter)

El filtro que se aplicará.

object (Order)

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

Firestore permite que los llamadores proporcionen un orden completo o parcial, o bien no proporcionar ningún orden. En todos los casos, Firestore garantiza un orden estable mediante las siguientes reglas:

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

A los campos se les agrega la misma dirección de orden que la del último orden especificado, o “ASCENDING”. si no se especificó ningún orden. Por ejemplo:

• ORDER BY a pasa a ser ORDER BY a ASC, __name__ ASC.
• ORDER BY a DESC pasa a ser ORDER BY a DESC, __name__ DESC.
• WHERE a > 1 pasa a ser WHERE a > 1 ORDER BY a ASC, __name__ ASC.
• WHERE __name__ > ... AND a > 1 pasa a ser WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC.

object (Cursor)

Es un posible prefijo 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 del ORDER BY proporcionado.

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

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

A diferencia de OFFSET, que requiere analizar los primeros N resultados para omitirlos, 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, sino que escaneará hacia adelante desde esta posición para encontrar el siguiente documento.

Requisitos:

• La cantidad de valores no puede ser mayor que la cantidad de campos especificados en la cláusula ORDER BY.

object (Cursor)

Un posible prefijo de una posición en el conjunto de resultados para finalizar la consulta.

Es similar a START_AT, pero controla la posición de finalización en lugar de la posición de inicio.

Requisitos:

• La cantidad de valores no puede ser mayor que la cantidad de campos especificados en la cláusula ORDER BY.

integer

La cantidad de documentos que se deben omitir antes de mostrar 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.

Requisitos:

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

integer

La cantidad máxima de resultados que se mostrarán.

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

Requisitos:

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

object (FindNearest)

Opcional. Una posible búsqueda de vecinos más cercanos.

Se aplica después de todos los demás filtros y orden.

Encuentra las incorporaciones vectoriales más cercanas al vector de consulta dado.