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 dos campos a serem retornados.

Isso atua como uma DocumentMask sobre os documentos retornados de uma consulta. Quando não definido, assume que o chamador deseja que todos os campos sejam retornados.

object ( CollectionSelector )

As coleções a serem consultadas.

object ( Filter )

O filtro a ser aplicado.

object ( Order )

A ordem a ser aplicada aos resultados da consulta.

O Firestore permite que os chamadores forneçam um pedido completo, um pedido parcial ou nenhum pedido. Em todos os casos, o Firestore garante um pedido estável através das seguintes regras:

• O orderBy é necessário para fazer referência a todos os campos usados ​​com um filtro de desigualdade.
• Todos os campos que precisam estar em orderBy , mas que ainda não estão presentes, são anexados na ordem lexicográfica do nome do campo.
• Se um pedido em __name__ não for especificado, ele será anexado por padrão.

Os campos são anexados com a mesma direção de classificação da última ordem especificada ou 'CRESCENTE' se nenhuma ordem foi especificada. Por exemplo:

• ORDER BY a torna-se ORDER BY a ASC, __name__ ASC
• ORDER BY a DESC torna-se ORDER BY a DESC, __name__ DESC
• WHERE a > 1 torna-se WHERE a > 1 ORDER BY a ASC, __name__ ASC
• WHERE __name__ > ... AND a > 1 torna-se WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

object ( Cursor )

Um prefixo potencial de uma posição no conjunto de resultados para iniciar a consulta.

A ordem do conjunto de resultados é baseada na cláusula ORDER BY da consulta original.

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

Os resultados desta consulta são ordenados por (b ASC, __name__ ASC) .

Os cursores podem fazer referência à ordem completa ou a um prefixo do local, embora não possam fazer referência a mais campos do que os que estão no ORDER BY fornecido.

Continuando com o exemplo acima, anexar os seguintes cursores iniciais terá impactos variados:

• START BEFORE (2, /k/123) : inicia a consulta logo antes a = 1 AND b > 2 AND __name__ > /k/123 .
• START AFTER (10) : inicia a consulta logo após a = 1 AND b > 10 .

Ao contrário OFFSET , que requer a varredura dos primeiros N resultados para pular, um cursor inicial permite que a consulta comece em uma posição lógica. Esta posição não é necessária para corresponder a um resultado real; ela avançará a partir desta posição para encontrar o próximo documento.

Requer:

• O número de valores não pode ser maior que o número de campos especificado na cláusula ORDER BY .

object ( Cursor )

Um prefixo potencial de uma posição no conjunto de resultados para encerrar a consulta.

Isso é semelhante a START_AT , mas controla a posição final em vez da posição inicial.

Requer:

• O número de valores não pode ser maior que o número de campos especificado na cláusula ORDER BY .

integer

O número de documentos a serem ignorados antes de retornar o primeiro resultado.

Isso se aplica após as restrições especificadas por WHERE , START AT e END AT mas antes da cláusula LIMIT .

Requer:

• O valor deve ser maior ou igual a zero, se especificado.

integer

O número máximo de resultados a serem retornados.

Aplica-se após todas as outras restrições.

Requer:

• O valor deve ser maior ou igual a zero, se especificado.