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)

Sottoinsieme facoltativo dei campi da restituire.

Agisce come DocumentMask per i documenti restituiti da una query. Se non impostato, presuppone che il chiamante voglia restituire tutti i campi.

object (CollectionSelector)

Le raccolte su cui eseguire una query.

object (Filter)

Il filtro da applicare.

object (Order)

L'ordine da applicare ai risultati della query.

Firestore consente ai chiamanti di fornire un ordinamento completo, parziale o nessun ordinamento. In tutti i casi, Firestore garantisce un ordinamento stabile tramite le seguenti regole:

• orderBy è obbligatorio per fare riferimento a tutti i campi utilizzati con un filtro di disuguaglianza.
• Tutti i campi che devono essere in orderBy, ma non sono già presenti, vengono aggiunti in ordine lessicografico del nome del campo.
• Se un ordine su __name__ non è specificato, viene aggiunto per impostazione predefinita.

Ai campi viene aggiunta la stessa direzione di ordinamento dell'ultimo ordine specificato, oppure "ASCENDENTE" se non è stato specificato alcun ordine. Ad esempio:

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

object (Cursor)

Un potenziale prefisso di una posizione nel set di risultati da cui iniziare la query.

L'ordine del set di risultati si basa sulla clausola ORDER BY della query originale.

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

I risultati di questa query sono ordinati per (b ASC, __name__ ASC).

I cursori possono fare riferimento all'ordine completo o a un prefisso della posizione, anche se non possono fare riferimento a più campi rispetto a quelli dell'elemento ORDER BY fornito.

Proseguendo con l'esempio precedente, l'aggiunta dei seguenti cursori di avvio avrà un impatto diverso:

• START BEFORE (2, /k/123): avvia la query subito prima di a = 1 AND b > 2 AND __name__ > /k/123.
• START AFTER (10): avvia la query subito dopo a = 1 AND b > 10.

A differenza di OFFSET, che richiede la scansione dei primi N risultati per saltare, un cursore di avvio consente alla query di iniziare in una posizione logica. Questa posizione non è necessaria per corrispondere a un risultato effettivo, verrà eseguita la scansione in avanti da questa posizione per trovare il documento successivo.

Richiede:

• Il numero di valori non può essere maggiore del numero di campi specificati nella clausola ORDER BY.

object (Cursor)

Un potenziale prefisso di una posizione nel set di risultati in cui terminare la query.

È simile a START_AT, ma controlla la posizione finale anziché la posizione iniziale.

Richiede:

• Il numero di valori non può essere maggiore del numero di campi specificati nella clausola ORDER BY.

integer

Il numero di documenti da saltare prima di restituire il primo risultato.

Questo si applica dopo i vincoli specificati da WHERE, START AT e END AT, ma prima della clausola LIMIT.

Richiede:

• Il valore deve essere maggiore o uguale a zero, se specificato.

integer

Il numero massimo di risultati da restituire.

Si applica dopo tutti gli altri vincoli.

Richiede:

• Il valore deve essere maggiore o uguale a zero, se specificato.

object (FindNearest)

Campo facoltativo. Una potenziale ricerca di vicini più vicini.

Si applica dopo tutti gli altri filtri e ordine.

Trova gli incorporamenti vettoriali più vicini al vettore di query specificato.