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

Ele atua como um DocumentMask sobre os documentos retornados de uma consulta. Quando não definido, presume que o autor da chamada quer 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 autores da chamada forneçam uma ordem completa, uma parcial ou nenhuma ordem. Em todos os casos, o Firestore garante uma ordem estável usando estas regras:

• O orderBy é obrigatório para referenciar todos os campos usados com um filtro de desigualdade.
• Todos os campos que precisam estar no orderBy, mas 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 que o último pedido especificado ou 'ASCENDING' se nenhum pedido tiver sido especificado. Exemplo:

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

object (Cursor)

Um possível prefixo de uma posição no conjunto de resultados em que a consulta será iniciada.

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 dessa consulta são ordenados por (b ASC, __name__ ASC).

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

Continuando com o exemplo acima, anexar os seguintes cursores iniciais terá um impacto variável:

• START BEFORE (2, /k/123): inicia a consulta logo antes de 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 de OFFSET, que requer a verificação 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 vai procurar o próximo documento nessa posição.

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 possível prefixo de uma posição no conjunto de resultados em que a consulta será encerrada.

Isso é semelhante ao 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 pulados 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 precisa ser maior ou igual a zero, se especificado.

integer

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

Aplica-se depois de todas as outras restrições.

Requer:

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

object (FindNearest)

Opcional. Uma potencial Pesquisa de vizinhos mais próximos.

Aplica-se depois de todos os outros filtros e ordens.

Encontra os embeddings vetoriais mais próximos ao vetor de consulta especificado.