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)

Optionale Teilmenge der zurückzugebenden Felder.

Sie dient als DocumentMask für die von einer Abfrage zurückgegebenen Dokumente. Wenn dieser Wert nicht festgelegt ist, wird davon ausgegangen, dass der Aufrufer alle Felder zurückgeben möchte.

object (CollectionSelector)

Die abzufragenden Sammlungen.

object (Filter)

Der Filter, der angewendet werden soll.

object (Order)

Die Reihenfolge, die auf die Abfrageergebnisse angewendet werden soll.

Mit Firestore können Aufrufer eine vollständige, teilweise oder gar keine Sortierung angeben. In allen Fällen garantiert Firestore eine stabile Reihenfolge anhand der folgenden Regeln:

• Der orderBy ist erforderlich, um auf alle Felder zu verweisen, die mit einem Ungleichheitsfilter verwendet werden.
• Alle Felder, die im orderBy enthalten sein müssen, aber noch nicht vorhanden sind, werden in lexikografischer Reihenfolge des Feldnamens angehängt.
• Wenn für __name__ kein Auftrag angegeben ist, wird er standardmäßig angehängt.

Die Felder werden mit derselben Sortierrichtung wie die zuletzt angegebene Reihenfolge oder „ASCENDING“ angehängt, wenn keine Reihenfolge angegeben wurde. Beispiel:

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

object (Cursor)

Ein potenzielles Präfix einer Position in der Ergebnismenge, an der die Abfrage gestartet werden soll.

Die Reihenfolge der Ergebnisse basiert auf der ORDER BY-Klausel der ursprünglichen Abfrage.

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

Die Ergebnisse dieser Abfrage sind nach (b ASC, __name__ ASC) sortiert.

Cursor können entweder auf die vollständige Reihenfolge oder ein Präfix des Standorts verweisen. Es können jedoch nicht mehr Felder als im angegebenen ORDER BY angegeben werden.

Ausgehend vom obigen Beispiel hat das Anhängen der folgenden Startcursor unterschiedliche Auswirkungen:

• START BEFORE (2, /k/123): Die Abfrage wird direkt vor a = 1 AND b > 2 AND __name__ > /k/123 gestartet.
• START AFTER (10): Die Abfrage wird direkt nach a = 1 AND b > 10 gestartet.

Im Gegensatz zu OFFSET, bei dem das Scannen über die ersten N Ergebnisse zum Überspringen erforderlich ist, ermöglicht ein Startcursor die Abfrage an einer logischen Position. Diese Position muss nicht mit einem tatsächlichen Ergebnis übereinstimmen. Von dieser Position aus wird das nächste Dokument vorwärts gespult.

Benötigt:

• Die Anzahl der Werte darf nicht größer sein als die Anzahl der Felder, die in der ORDER BY-Klausel angegeben sind.

object (Cursor)

Ein potenzielles Präfix einer Position im Ergebnissatz, bei der die Abfrage beendet werden soll.

Dies ist ähnlich wie START_AT, legt jedoch nicht die Startposition, sondern die Endposition fest.

Benötigt:

• Die Anzahl der Werte darf nicht größer sein als die Anzahl der Felder, die in der ORDER BY-Klausel angegeben sind.

integer

Die Anzahl der Dokumente, die übersprungen werden sollen, bevor das erste Ergebnis zurückgegeben wird.

Dies gilt nach den von WHERE, START AT und END AT angegebenen Einschränkungen, aber vor der LIMIT-Klausel.

Benötigt:

• Der Wert muss größer oder gleich null sein, falls angegeben.

integer

Die maximale Anzahl von zurückzugebenden Ergebnissen.

Wird nach allen anderen Einschränkungen angewendet.

Benötigt:

• Der Wert muss größer oder gleich null sein, falls angegeben.

object (FindNearest)

Optional. Eine potenzielle Suche nach den nächstgelegenen Nachbarn.

Wird nach allen anderen Filtern und Sortierungen angewendet.

Findet die Vektoreinbettungen, die dem angegebenen Abfragevektor am nächsten sind.