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)

Sous-ensemble facultatif de champs à renvoyer.

Il agit comme un DocumentMask sur les documents renvoyés par une requête. Si cette règle n'est pas définie, cela suppose que l'appelant souhaite que tous les champs soient renvoyés.

object (CollectionSelector)

Collections à interroger.

object (Filter)

Filtre à appliquer.

object (Order)

Ordre à appliquer aux résultats de la requête.

Firestore permet aux appelants de proposer un tri complet, un ordre partiel ou un ordre nul. Dans tous les cas, Firestore garantit un ordre stable grâce aux règles suivantes:

• orderBy est obligatoire pour référencer tous les champs utilisés avec un filtre d'inégalité.
• Tous les champs qui doivent figurer dans orderBy, mais qui ne sont pas déjà présents sont ajoutés selon l'ordre lexicographique du nom du champ.
• Si une commande sur __name__ n'est pas spécifiée, elle est ajoutée par défaut.

Les champs sont ajoutés avec le même sens de tri que le dernier ordre spécifié ou "ASCENDING" si aucun ordre n'a été spécifié. Exemple :

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

object (Cursor)

Préfixe potentiel d'une position dans l'ensemble de résultats à laquelle la requête doit commencer.

L'ordre de l'ensemble de résultats est basé sur la clause ORDER BY de la requête d'origine.

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

Les résultats de cette requête sont classés par (b ASC, __name__ ASC).

Les curseurs peuvent faire référence à l'ordre complet ou au préfixe du lieu, bien qu'ils ne puissent pas référencer plus de champs que le ORDER BY fourni.

Pour reprendre l'exemple ci-dessus, l'association des curseurs de début suivants aura un impact variable:

• START BEFORE (2, /k/123): commencer la requête juste avant a = 1 AND b > 2 AND __name__ > /k/123.
• START AFTER (10): lancer la requête juste après a = 1 AND b > 10.

Contrairement à OFFSET, qui nécessite d'analyser les N premiers résultats à ignorer, un curseur de début permet à la requête de commencer à une position logique. Cette position n'est pas obligatoire pour correspondre à un résultat réel. La recherche s'effectue à partir de cette position pour trouver le document suivant.

Configuration requise:

• Le nombre de valeurs ne peut pas être supérieur au nombre de champs spécifié dans la clause ORDER BY.

object (Cursor)

Préfixe potentiel d'une position dans l'ensemble de résultats à laquelle terminer la requête.

Cette méthode est semblable à START_AT, mais elle contrôle la position de fin plutôt que la position de départ.

Configuration requise:

• Le nombre de valeurs ne peut pas être supérieur au nombre de champs spécifié dans la clause ORDER BY.

integer

Nombre de documents à ignorer avant de renvoyer le premier résultat.

Cela s'applique après les contraintes spécifiées par WHERE, START AT et END AT, mais avant la clause LIMIT.

Configuration requise:

• Si elle est spécifiée, la valeur doit être supérieure ou égale à zéro.

integer

Nombre maximal de résultats à renvoyer.

S'applique après toutes les autres contraintes.

Configuration requise:

• Si elle est spécifiée, la valeur doit être supérieure ou égale à zéro.

object (FindNearest)

Facultatif. Recherche des voisins les plus proches possible.

S'applique après tous les autres filtres et tris.

Recherche les représentations vectorielles continues les plus proches du vecteur de requête donné.