Package google.firestore.v1beta1

map<string, Value>

Das Ergebnis der Aggregatfunktionen, z. B. COUNT(*) AS total_docs.

Der Schlüssel ist die alias, die der Aggregationsfunktion bei der Eingabe zugewiesen wird. Die Größe dieser Zuordnung entspricht der Anzahl der Aggregationsfunktionen in der Abfrage.

Value

Werte im Array.

string

Erforderlich. Der Datenbankname. Im Format: projects/{project_id}/databases/{database_id}.

string

Die Namen der abzurufenden Dokumente. Im Format: projects/{project_id}/databases/{database_id}/documents/{document_path}. Die Anfrage schlägt fehl, wenn eines der Dokumente keine untergeordnete Ressource des angegebenen database ist. Doppelte Namen werden entfernt.

DocumentMask

Die zurückzugebenden Felder. Wenn nicht festgelegt, werden alle Felder zurückgegeben.

Wenn ein Dokument ein Feld enthält, das in dieser Maske nicht vorhanden ist, wird dieses Feld nicht in der Antwort zurückgegeben.

bytes

Liest Dokumente in einer Transaktion.

TransactionOptions

Startet eine neue Transaktion und liest die Dokumente. Die Standardeinstellung ist eine schreibgeschützte Transaktion. Die neue Transaktions-ID wird als erste Antwort im Stream zurückgegeben.

Timestamp

Liest Dokumente so, wie sie zum jeweiligen Zeitpunkt waren.

Dabei muss es sich um einen Zeitstempel mit einer Genauigkeit von Mikrosekunden innerhalb der letzten Stunde handeln. Wenn die Wiederherstellung zu einem bestimmten Zeitpunkt aktiviert ist, kann zusätzlich ein Zeitstempel einer ganzen Minute innerhalb der letzten 7 Tage angegeben werden.

bytes

Die Transaktion, die im Rahmen dieser Anfrage gestartet wurde. Wird nur in der ersten Antwort und nur dann festgelegt, wenn in der Anfrage BatchGetDocumentsRequest.new_transaction festgelegt wurde.

Timestamp

Der Zeitpunkt, zu dem das Dokument gelesen wurde. Dieser Wert kann kontinuierlich ansteigen. In diesem Fall ist sichergestellt, dass sich die vorherigen Dokumente im Ergebnisstream zwischen ihrer read_time und diesem nicht geändert haben.

Document

Ein angefordertes Dokument.

string

Ein Dokumentname, der angefordert wurde, aber nicht vorhanden ist. Im Format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string

Erforderlich. Der Datenbankname. Im Format: projects/{project_id}/databases/{database_id}.

Write

Die anzuwendenden Schreibvorgänge.

Die Methode wendet Schreibvorgänge nicht atomar an und garantiert keine Sortierung. Jeder Schreibvorgang ist unabhängig voneinander erfolgreich oder schlägt fehl. Sie können pro Anfrage nur einmal in dasselbe Dokument schreiben.

map<string, string>

Labels, die mit diesem Batchschreibvorgang verknüpft sind.

WriteResult

Das Ergebnis der Anwendung der Schreibvorgänge.

Dieses i-te Schreibergebnis entspricht dem i-ten Schreibvorgang in der Anfrage.

Status

Der Status der Anwendung der Schreibvorgänge.

Dieser i-te Schreibstatus entspricht dem i-ten Schreibvorgang in der Anfrage.

string

Erforderlich. Der Datenbankname. Im Format: projects/{project_id}/databases/{database_id}.

TransactionOptions

Die Optionen für die Transaktion. Die Standardeinstellung ist eine Lese-Schreib-Transaktion.

bytes

Die gestartete Transaktion.

bytes

Die Byte, die die Bitsequenz codieren. Kann eine Länge von null haben.

int32

Die Anzahl der Bits des letzten Byte in bitmap, die als „Padding“ ignoriert werden sollen. Wenn die Länge von bitmap null ist, muss dieser Wert 0 sein. Andernfalls muss dieser Wert zwischen 0 und 7 (einschließlich) liegen.

BitSequence

Die Bloom-Filterdaten.

int32

Die Anzahl der vom Algorithmus verwendeten Hashes.

string

Erforderlich. Der Datenbankname. Im Format: projects/{project_id}/databases/{database_id}.

Write

Die anzuwendenden Schreibvorgänge.

Immer atomar und in der richtigen Reihenfolge ausgeführt.

bytes

Wenn festgelegt, werden alle Schreibvorgänge in dieser Transaktion angewendet und ein Commit durchgeführt.

WriteResult

Das Ergebnis der Anwendung der Schreibvorgänge.

Dieses i-te Schreibergebnis entspricht dem i-ten Schreibvorgang in der Anfrage.

Timestamp

Der Zeitpunkt, zu dem der Commit ausgeführt wurde. Jeder Lesevorgang mit einem gleich oder größer als read_time erkennt die Auswirkungen des Commits garantiert.

string

Erforderlich. Die übergeordnete Ressource. Beispiel: projects/{project_id}/databases/{database_id}/documents oder projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

string

Erforderlich. Die Sammlungs-ID, relativ zu parent, die aufgelistet werden soll. Beispiel: chatrooms

string

Die vom Kunden zugewiesene Dokument-ID, die für dieses Dokument verwendet werden soll.

Optional. Wenn keine Angabe erfolgt, wird vom Dienst eine ID zugewiesen.

Document

Erforderlich. Das zu erstellende Dokument. name darf nicht festgelegt werden.

DocumentMask

Die zurückzugebenden Felder. Wenn nicht festgelegt, werden alle Felder zurückgegeben.

Wenn das Dokument ein Feld enthält, das in dieser Maske nicht vorhanden ist, wird dieses Feld nicht in der Antwort zurückgegeben.

Value

Die Werte, die eine Position in der Reihenfolge darstellen, in der sie in der Order by-Klausel einer Abfrage vorkommen.

Kann weniger Werte enthalten, als in der Klausel „order by“ angegeben sind.

bool

Wenn die Position kurz vor oder direkt nach den angegebenen Werten liegt, relativ zur durch die Abfrage definierten Sortierreihenfolge.

string

Erforderlich. Der Ressourcenname des Dokuments, das gelöscht werden soll. Im Format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Precondition

Eine optionale Vorbedingung für das Dokument. Die Anfrage schlägt fehl, wenn dies festgelegt und vom Zieldokument nicht erfüllt wird.

string

Der Ressourcenname des Dokuments, z. B. projects/{project_id}/databases/{database_id}/documents/{document_path}.

map<string, Value>

Timestamp

Nur Ausgabe Der Zeitpunkt, zu dem das Dokument erstellt wurde.

Dieser Wert erhöht sich monoton, wenn ein Dokument gelöscht und dann neu erstellt wird. Er kann auch mit Werten aus anderen Dokumenten und dem read_time einer Abfrage verglichen werden.

Timestamp

Nur Ausgabe Der Zeitpunkt, zu dem das Dokument zuletzt geändert wurde.

Dieser Wert wird anfangs auf create_time gesetzt und erhöht sich dann bei jeder Änderung am Dokument monoton. Er kann auch mit Werten aus anderen Dokumenten und dem read_time einer Abfrage verglichen werden.

Document

Der neue Status von Document.

Wenn mask festgelegt ist, enthält es nur Felder, die aktualisiert oder hinzugefügt wurden.

int32

Eine Reihe von Ziel-IDs von Zielen, die mit diesem Dokument übereinstimmen.

int32

Eine Reihe von Ziel-IDs für Ziele, die nicht mehr mit diesem Dokument übereinstimmen.

string

Der Ressourcenname der Document, die gelöscht wurde.

int32

Eine Reihe von Ziel-IDs für Ziele, die zuvor mit dieser Entität übereinstimmten.

Timestamp

Der Lesezeitstempel, zu dem der Löschvorgang beobachtet wurde.

Ist größer oder gleich dem commit_time des Löschvorgangs.

string

Die Liste der Feldpfade in der Maske. Eine Syntaxreferenz für Feldpfade finden Sie unter Document.fields.

string

Der Ressourcenname des Document, der nicht mehr angezeigt wird.

int32

Eine Reihe von Ziel-IDs für Ziele, die zuvor mit diesem Dokument übereinstimmen.

Timestamp

Der Lesezeitstempel, zu dem die Entfernung beobachtet wurde.

Ist größer oder gleich commit_time der Änderung/Löschung/Entfernung.

string

Der Name des zu transformierenden Dokuments.

FieldTransform

Die Liste der Transformationen, die in der angegebenen Reihenfolge auf die Felder des Dokuments angewendet werden sollen. Dieses Feld darf nicht leer sein.

string

Der Pfad des Felds. Die Syntaxreferenz für Feldpfade finden Sie unter Document.fields.

ServerValue

Setzt das Feld auf den angegebenen Serverwert.

Value

Fügt den angegebenen Wert zum aktuellen Wert des Felds hinzu.

Dies muss eine Ganzzahl oder ein doppelter Wert sein. Wenn das Feld keine Ganzzahl oder kein Double-Wert ist oder das Feld noch nicht vorhanden ist, wird das Feld von der Transformation auf den angegebenen Wert festgelegt. Wenn einer der angegebenen Werte oder der aktuelle Feldwert doppelt vorhanden ist, werden beide Werte als Double-Werten interpretiert. Die Doppelarithmetik und die Darstellung von Doppelwerten folgen der IEEE 754-Semantik. Bei einem Überlauf der positiven/negativen Ganzzahlen wird das Feld in die höchste positive/negative Ganzzahl aufgelöst.

Value

Legt das Feld auf das Maximum des aktuellen und angegebenen Werts fest.

Dies muss eine Ganzzahl oder ein doppelter Wert sein. Wenn das Feld keine Ganzzahl oder kein Double-Wert ist oder das Feld noch nicht vorhanden ist, wird das Feld von der Transformation auf den angegebenen Wert festgelegt. Wenn eine Maximal-Operation angewendet wird, bei der das Feld und der Eingabewert gemischte Typen haben (eins ist eine Ganzzahl und der andere ein Double-Wert), übernimmt das Feld den Typ des größeren Operanden. Wenn die Operanden äquivalent sind (z. B. 3 und 3,0), bleibt das Feld unverändert. 0, 0,0 und -0,0 sind alle Null. Der Höchstwert aus einem gespeicherten Wert von null und einem Eingabewert von null ist immer der gespeicherte Wert. Das Maximum eines beliebigen numerischen Werts x und NaN ist NaN.

Value

Legt das Feld auf den Mindestwert des aktuellen und des angegebenen Werts fest.

Dies muss eine Ganzzahl oder ein doppelter Wert sein. Wenn das Feld keine Ganzzahl oder kein Double-Wert ist oder das Feld noch nicht vorhanden ist, wird das Feld von der Transformation auf den Eingabewert festgelegt. Wenn eine Operation mit Minimum angewendet wird, bei der das Feld und der Eingabewert gemischte Typen haben (eins ist eine Ganzzahl und der andere ein Double-Wert), übernimmt das Feld den Typ des kleineren Operanden. Wenn die Operanden äquivalent sind (z. B. 3 und 3,0), bleibt das Feld unverändert. 0, 0,0 und -0,0 sind alle Null. Der Mindestwert eines gespeicherten Werts von null und eines Eingabewerts von null ist immer der gespeicherte Wert. Das Minimum aller numerischen Werte x und NaN ist NaN.

ArrayValue

Hängen Sie die Elemente der Reihe nach an, wenn sie nicht bereits im aktuellen Feldwert vorhanden sind. Wenn das Feld kein Array ist oder das Feld noch nicht vorhanden ist, wird es zuerst auf das leere Array festgelegt.

Gleichwertige Zahlen unterschiedlicher Typen (z. B. 3L und 3,0) gelten bei der Überprüfung auf fehlende Werte als gleich. NaN ist gleich NaN und Null ist gleich Null. Wenn die Eingabe mehrere äquivalente Werte enthält, wird nur der erste berücksichtigt.

Das entsprechende transform_result ist der Nullwert.

ArrayValue

Entfernt alle angegebenen Elemente aus dem Array im Feld. Wenn das Feld kein Array ist oder das Feld noch nicht vorhanden ist, wird es auf das leere Array festgelegt.

Äquivalente Zahlen der verschiedenen Typen (z.B. 3L und 3.0) gelten bei der Entscheidung, ob ein Element entfernt werden soll, als gleich. NaN ist gleich NaN und Null ist gleich Null. Dadurch werden alle entsprechenden Werte entfernt, falls es Duplikate gibt.

Das entsprechende transform_result ist der Nullwert.

int64

Gesamtzahl der zurückgegebenen Ergebnisse, einschließlich Dokumenten, Projektionen, Aggregationsergebnissen und Schlüssel.

Duration

Gesamtzeit für die Ausführung der Abfrage im Back-End.

int64

Abrechenbare Lesevorgänge insgesamt.

Struct

Debugging von Statistiken aus der Ausführung der Abfrage Beachten Sie, dass sich die Debugging-Statistiken im Zuge der Weiterentwicklung von Firestore ändern können. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

int32

Die Ziel-ID, auf die dieser Filter angewendet wird.

int32

Die Gesamtzahl der Dokumente, die mit target_id übereinstimmen.

Wenn sich die Anzahl der übereinstimmenden Dokumente im Client von der Anzahl der übereinstimmenden Dokumente unterscheidet, muss der Kunde manuell ermitteln, welche Dokumente nicht mehr dem Ziel entsprechen.

Der Kunde kann dazu den Bloomfilter unchanged_names verwenden, um ALLE Dokumentnamen mit dem Filter zu vergleichen. Wenn der Dokumentname NICHT im Filter ist, bedeutet dies, dass das Dokument nicht mehr mit dem Ziel übereinstimmt.

BloomFilter

Ein Bloomfilter, der trotz seines Namens die UTF-8-Bytecodierungen der Ressourcennamen ALLER Dokumente im Format projects/{project_id}/databases/{database_id}/documents/{document_path} enthält, die mit target_id übereinstimmen.

Dieser Bloomfilter kann nach Ermessen des Servers weggelassen werden, z. B. wenn davon auszugehen ist, dass der Client ihn nicht nutzt, oder wenn die Berechnung oder Übertragung zu aufwendig ist. Clients müssen souverän damit umgehen, dass dieses Feld fehlt, indem sie auf die Logik zurückgreifen, die vor dem Vorhandensein dieses Feldes verwendet wurde. Das heißt, das Ziel ohne Lebenslauftoken erneut hinzufügen, um festzustellen, welche Dokumente im Client-Cache nicht synchron sind.

PlanSummary

Informationen zur Planungsphase für die Abfrage.

ExecutionStats

Aggregierte Statistiken aus der Ausführung der Abfrage. Nur vorhanden, wenn ExplainOptions.analyze auf „true“ gesetzt ist.

bool

Optional. Gibt an, ob diese Abfrage ausgeführt werden soll.

Ist dieser Wert auf „false“ gesetzt (Standardeinstellung), wird die Abfrage geplant und es werden nur Messwerte aus den Planungsphasen zurückgegeben.

Bei „true“ wird die Abfrage geplant und ausgeführt und die vollständigen Abfrageergebnisse sowie Messwerte für die Planungs- und Ausführungsphase zurückgegeben.

string

Erforderlich. Der Ressourcenname des abzurufenden Dokuments. Im Format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentMask

Die zurückzugebenden Felder. Wenn nicht festgelegt, werden alle Felder zurückgegeben.

Wenn das Dokument ein Feld enthält, das in dieser Maske nicht vorhanden ist, wird dieses Feld nicht in der Antwort zurückgegeben.

bytes

Liest das Dokument in einer Transaktion.

Timestamp

Liest die Version des Dokuments zum angegebenen Zeitpunkt.

Dabei muss es sich um einen Zeitstempel mit einer Genauigkeit von Mikrosekunden innerhalb der letzten Stunde handeln. Wenn die Wiederherstellung zu einem bestimmten Zeitpunkt aktiviert ist, kann zusätzlich ein Zeitstempel einer ganzen Minute innerhalb der letzten 7 Tage angegeben werden.

string

Erforderlich. Das übergeordnete Dokument. Im Format: projects/{project_id}/databases/{database_id}/documents/{document_path}. Beispiel: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

int32

Die maximale Anzahl von zurückzugebenden Ergebnissen.

string

Ein Seitentoken. Muss ein Wert aus ListCollectionIdsResponse sein.

Timestamp

Liest Dokumente so, wie sie zum jeweiligen Zeitpunkt waren.

Dabei muss es sich um einen Zeitstempel mit einer Genauigkeit von Mikrosekunden innerhalb der letzten Stunde handeln. Wenn die Wiederherstellung zu einem bestimmten Zeitpunkt aktiviert ist, kann zusätzlich ein Zeitstempel einer ganzen Minute innerhalb der letzten 7 Tage angegeben werden.

string

Die Sammlungs-IDs.

string

Ein Seitentoken, mit dem die Liste fortgesetzt werden kann.

string

Erforderlich. Der Name der übergeordneten Ressource. Im Format: projects/{project_id}/databases/{database_id}/documents oder projects/{project_id}/databases/{database_id}/documents/{document_path}.

Beispiel: projects/my-project/databases/my-database/documents oder projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

Optional. Die Sammlungs-ID, relativ zu parent, die aufgelistet werden soll.

Beispiel: chatrooms oder messages.

Dies ist optional. Wenn keine Angabe erfolgt, listet Firestore Dokumente aus allen Sammlungen unter der angegebenen parent auf.

int32

Optional. Die maximale Anzahl von Dokumenten, die in einer einzelnen Antwort zurückgegeben werden sollen.

Firestore gibt möglicherweise weniger als diesen Wert zurück.

string

Optional. Ein Seitentoken, das von einer vorherigen ListDocuments-Antwort empfangen wurde.

Geben Sie diese an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen Parameter (mit Ausnahme von page_size) mit den Werten übereinstimmen, die in der Anfrage festgelegt wurden, mit der das Seitentoken generiert wurde.

string

Optional. Die optionale Reihenfolge der zurückzugebenden Dokumente.

Beispiel: priority desc, __name__ desc.

Dies spiegelt die ORDER BY wider, die in Firestore-Abfragen verwendet wird, aber in einer Stringdarstellung. Wenn keine vorhanden sind, werden die Dokumente nach __name__ ASC sortiert.

DocumentMask

Optional. Die zurückzugebenden Felder. Wenn nicht festgelegt, werden alle Felder zurückgegeben.

Wenn ein Dokument ein Feld enthält, das in dieser Maske nicht vorhanden ist, wird dieses Feld nicht in der Antwort zurückgegeben.

bool

Gibt an, ob in der Liste fehlende Dokumente angezeigt werden sollen.

Ein Dokument fehlt, wenn es nicht existiert, aber darunter sind Unterdokumente verschachtelt. Wenn dieser Wert auf „true“ gesetzt ist, werden solche Dokumente mit einem Schlüssel zurückgegeben. Es sind jedoch keine Felder, create_time oder update_time festgelegt.

Anfragen mit show_missing dürfen nicht where oder order_by enthalten.

bytes

Führt den Lesevorgang als Teil einer bereits aktiven Transaktion aus.

Timestamp

Führe den Lesevorgang zur angegebenen Zeit aus.

Dabei muss es sich um einen Zeitstempel mit einer Genauigkeit von Mikrosekunden innerhalb der letzten Stunde handeln. Wenn die Wiederherstellung zu einem bestimmten Zeitpunkt aktiviert ist, kann zusätzlich ein Zeitstempel einer ganzen Minute innerhalb der letzten 7 Tage angegeben werden.

Document

Die gefundenen Dokumente.

string

Ein Token zum Abrufen der nächsten Seite mit Dokumenten.

Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

string

Erforderlich. Der Datenbankname. Im Format: projects/{project_id}/databases/{database_id}.

map<string, string>

Labels, die mit dieser Zieländerung verknüpft sind.

Target

Ein Ziel, das diesem Stream hinzugefügt werden soll.

int32

Die ID eines Ziels, das aus diesem Stream entfernt werden soll.

TargetChange

Die Ziele haben sich geändert.

DocumentChange

Ein Document hat sich geändert.

DocumentDelete

Ein Document wurde gelöscht.

DocumentRemove

Ein Document wurde aus einem Ziel entfernt, da er für dieses Ziel nicht mehr relevant ist.

ExistenceFilter

Ein Filter, der auf den Satz von Dokumenten angewendet wird, die zuvor für das angegebene Ziel zurückgegeben wurden.

Wird zurückgegeben, wenn Dokumente möglicherweise aus dem angegebenen Ziel entfernt wurden, die genauen Dokumente jedoch nicht bekannt sind.

map<string, Value>

Die Felder der Karte

Die Zuordnungsschlüssel stellen Feldnamen dar. Feldnamen, die mit dem regulären Ausdruck __.*__ übereinstimmen, sind reserviert. Reservierte Feldnamen sind nur in bestimmten dokumentierten Kontexten zulässig. Die als UTF-8 dargestellten Kartenschlüssel dürfen 1.500 Byte nicht überschreiten und dürfen nicht leer sein.

string

Erforderlich. Der Name der übergeordneten Ressource. Im Format: projects/{project_id}/databases/{database_id}/documents. Dokumentressourcennamen werden nicht unterstützt. Es können nur Namen für Datenbankressourcen angegeben werden.

int64

Die gewünschte maximale Anzahl von Partitionspunkten. Die Partitionen können über mehrere Ergebnisseiten hinweg zurückgegeben werden. Die Zahl muss positiv sein. Die tatsächliche Anzahl der zurückgegebenen Partitionen kann geringer sein.

Dieser kann beispielsweise auf ein weniger als die Anzahl der auszuführenden parallelen Abfragen oder beim Ausführen eines Datenpipelinejobs um eins weniger als die Anzahl der verfügbaren Worker oder Recheninstanzen festgelegt werden.

string

Der next_page_token-Wert, der von einem vorherigen Aufruf an PartitionQuery zurückgegeben wurde und zum Abrufen weiterer Ergebnisse verwendet werden kann. Es gibt keine Garantien für die Reihenfolge zwischen den Ergebnissätzen. Wenn also mehrere Ergebnissätze verwendet werden, müssen die verschiedenen Ergebnissätze zusammengeführt werden.

Beispiel: Zwei aufeinanderfolgende Aufrufe mit einem page_token können Folgendes zurückgeben:

• Cursor B, Cursor M, Cursor Q
• Cursor A, Cursor U, Cursor W

Um einen vollständigen Ergebnissatz zu erhalten, geordnet nach den Ergebnissen der an PartitionQuery übergebenen Abfrage, sollten die Ergebnissätze zusammengeführt werden: Cursor A, Cursor B, Cursor M, Cursor Q, Cursor U, Cursor W.

int32

Die maximale Anzahl von Partitionen, die in diesem Aufruf zurückgegeben werden sollen, vorbehaltlich partition_count.

Wenn beispielsweise partition_count = 10 und page_size = 8 ist, gibt der erste Aufruf von „PartitionQuery“ bis zu acht Partitionen und einen next_page_token zurück, wenn mehr Ergebnisse vorhanden sind. Ein zweiter Aufruf von PartitionQuery gibt bis zu 2 Partitionen zurück, um die insgesamt in partition_count angegebenen 10 Partitionen abzuschließen.

StructuredQuery

Eine strukturierte Abfrage. In der Abfrage muss eine Sammlung mit allen Nachfolgerelementen angegeben und nach Namen aufsteigend sortiert werden. Andere Filter, Sortierungen nach, Grenzwerte, Offsets und Start-/End-Cursor werden nicht unterstützt.

Timestamp

Liest Dokumente so, wie sie zum jeweiligen Zeitpunkt waren.

Dabei muss es sich um einen Zeitstempel mit einer Genauigkeit von Mikrosekunden innerhalb der letzten Stunde handeln. Wenn die Wiederherstellung zu einem bestimmten Zeitpunkt aktiviert ist, kann zusätzlich ein Zeitstempel einer ganzen Minute innerhalb der letzten 7 Tage angegeben werden.

Cursor

Partitionsergebnisse. Jede Partition ist ein Aufteilungspunkt, der von RunQuery als Start- oder Endpunkt für die Abfrageergebnisse verwendet werden kann. RunQuery-Anfragen müssen mit der Abfrage gestellt werden, die für diese PartitionQuery-Anfrage angegeben wurde. Die Partitions-Cursor werden in derselben Reihenfolge angeordnet wie die Ergebnisse der an PartitionQuery übergebenen Abfrage.

Wenn eine PartitionQuery-Anfrage beispielsweise die Partitionscursor A und B zurückgibt, wird bei der Ausführung der folgenden drei Abfragen der gesamte Ergebnissatz der ursprünglichen Abfrage zurückgegeben:

• Abfrage, Ende_bei A
• Abfrage, Start_bei A, Ende_bei B
• Abfrage, Start bei B

Ein leeres Ergebnis kann darauf hindeuten, dass die Abfrage zu wenige Ergebnisse zum Partitionieren hat oder dass die Partitionierung der Abfrage noch nicht unterstützt wird.

string

Ein Seitentoken, mit dem eine zusätzliche Ergebnismenge angefordert werden kann, bis zu der durch partition_count in der PartitionQuery-Anfrage angegebenen Anzahl. Wenn das Feld leer ist, gibt es keine weiteren Ergebnisse.

Struct

Die für die Abfrage ausgewählten Indexe. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

bool

Wenn der Wert auf true gesetzt ist, muss das Zieldokument vorhanden sein. Wenn der Wert auf false gesetzt ist, darf das Zieldokument nicht vorhanden sein.

Timestamp

Wenn festgelegt, muss das Zieldokument vorhanden und zu diesem Zeitpunkt zuletzt aktualisiert worden sein. Der Zeitstempel muss auf Mikrosekunden ausgerichtet sein.

string

Erforderlich. Der Datenbankname. Im Format: projects/{project_id}/databases/{database_id}.

bytes

Erforderlich. Die Transaktion, für die ein Rollback durchgeführt werden soll.

string

Erforderlich. Der Name der übergeordneten Ressource. Im Format: projects/{project_id}/databases/{database_id}/documents oder projects/{project_id}/databases/{database_id}/documents/{document_path}. Beispiel: projects/my-project/databases/my-database/documents oder projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

Optional. Erläutern Sie Optionen für die Abfrage. Wenn festgelegt, werden zusätzliche Abfragestatistiken zurückgegeben. Andernfalls werden nur Abfrageergebnisse zurückgegeben.

StructuredAggregationQuery

Eine Aggregationsabfrage.

bytes

Führen Sie die Aggregation innerhalb einer bereits aktiven Transaktion aus.

Der Wert hier ist die intransparente Transaktions-ID, in der die Abfrage ausgeführt wird.

TransactionOptions

Startet im Rahmen der Abfrage eine neue Transaktion und ist standardmäßig schreibgeschützt.

Die neue Transaktions-ID wird als erste Antwort im Stream zurückgegeben.

Timestamp

Führt die Abfrage zum angegebenen Zeitstempel aus.

Dabei muss es sich um einen Zeitstempel mit einer Genauigkeit von Mikrosekunden innerhalb der letzten Stunde handeln. Wenn die Wiederherstellung zu einem bestimmten Zeitpunkt aktiviert ist, kann zusätzlich ein Zeitstempel einer ganzen Minute innerhalb der letzten 7 Tage angegeben werden.

AggregationResult

Ein einzelnes Aggregationsergebnis.

Nicht vorhanden, wenn ein teilweiser Fortschritt gemeldet wird.

bytes

Die Transaktion, die im Rahmen dieser Anfrage gestartet wurde.

Ist nur in der ersten Antwort vorhanden, wenn die Anfrage den Start einer neuen Transaktion angefordert hat.

Timestamp

Der Zeitpunkt, zu dem das aggregierte Ergebnis berechnet wurde. Dieser Wert erhöht sich immer kontinuierlich. In diesem Fall hat sich das vorherige Aggregationsergebnis im Ergebnisstream garantiert zwischen read_time und diesem nicht geändert.

Wenn die Abfrage keine Ergebnisse zurückgibt, wird eine Antwort mit read_time und ohne result gesendet. Dies gibt den Zeitpunkt an, zu dem die Abfrage ausgeführt wurde.

ExplainMetrics

Messwerte zur Abfrage erklären. Es ist nur vorhanden, wenn RunAggregationQueryRequest.explain_options angegeben ist, und wird nur einmal mit der letzten Antwort im Stream gesendet.

string

Erforderlich. Der Name der übergeordneten Ressource. Im Format: projects/{project_id}/databases/{database_id}/documents oder projects/{project_id}/databases/{database_id}/documents/{document_path}. Beispiel: projects/my-project/databases/my-database/documents oder projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

Optional. Erläutern Sie Optionen für die Abfrage. Wenn festgelegt, werden zusätzliche Abfragestatistiken zurückgegeben. Andernfalls werden nur Abfrageergebnisse zurückgegeben.

StructuredQuery

Eine strukturierte Abfrage.

bytes

Führen Sie die Abfrage in einer bereits aktiven Transaktion aus.

Der Wert hier ist die intransparente Transaktions-ID, in der die Abfrage ausgeführt wird.

TransactionOptions

Startet eine neue Transaktion und liest die Dokumente. Die Standardeinstellung ist eine schreibgeschützte Transaktion. Die neue Transaktions-ID wird als erste Antwort im Stream zurückgegeben.

Timestamp

Liest Dokumente so, wie sie zum jeweiligen Zeitpunkt waren.

Dabei muss es sich um einen Zeitstempel mit einer Genauigkeit von Mikrosekunden innerhalb der letzten Stunde handeln. Wenn die Wiederherstellung zu einem bestimmten Zeitpunkt aktiviert ist, kann zusätzlich ein Zeitstempel einer ganzen Minute innerhalb der letzten 7 Tage angegeben werden.

bytes

Die Transaktion, die im Rahmen dieser Anfrage gestartet wurde. Kann nur in der ersten Antwort und nur dann festgelegt werden, wenn in der Anfrage RunQueryRequest.new_transaction festgelegt wurde. Wenn festgelegt, werden in dieser Antwort keine anderen Felder festgelegt.

Document

Ein Abfrageergebnis, das nicht festgelegt ist, wenn ein Teilfortschritt gemeldet wird.

Timestamp

Der Zeitpunkt, zu dem das Dokument gelesen wurde. Dieser Wert kann kontinuierlich ansteigen. In diesem Fall wird sichergestellt, dass sich die vorherigen Dokumente im Ergebnisstream zwischen ihrem read_time und diesem Dokument nicht geändert haben.

Wenn die Abfrage keine Ergebnisse zurückgibt, wird eine Antwort mit read_time und ohne document gesendet. Dies gibt den Zeitpunkt an, zu dem die Abfrage ausgeführt wurde.

int32

Die Anzahl der Ergebnisse, die aufgrund eines Offsets zwischen der letzten Antwort und der aktuellen Antwort übersprungen wurden.

ExplainMetrics

Messwerte zur Abfrage erklären. Es ist nur vorhanden, wenn RunQueryRequest.explain_options angegeben ist, und wird nur einmal mit der letzten Antwort im Stream gesendet.

bool

Falls vorhanden, hat Firestore die Anfrage vollständig abgeschlossen und es werden keine weiteren Dokumente zurückgegeben.

Aggregation

Optional. Reihe von Aggregationen, die auf die Ergebnisse von structured_query angewendet werden sollen.

Benötigt:

• Mindestens eine und maximal fünf Aggregationen pro Abfrage.

StructuredQuery

Verschachtelte strukturierte Abfrage.

string

Optional. Optionaler Name des Felds, in dem das Ergebnis der Aggregation gespeichert werden soll.

Wenn nicht angegeben, wählt Firestore einen Standardnamen im Format field_<incremental_id++> aus. Beispiel:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2),
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*)
OVER (
  ...
);

wird zu:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2) AS field_1,
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*) AS field_2
OVER (
  ...
);

Benötigt:

• Muss für alle Aggregationsaliasse eindeutig sein.
• Die Einschränkungen von document field name einhalten.

Count

Anzahl-Aggregator.

Sum

Summen-Aggregator.

Avg

Durchschnittlicher Aggregator.

FieldReference

Das Feld, für das die Daten aggregiert werden sollen.

Int64Value

Optional. Optionale Einschränkung der maximalen Anzahl von zu zählenden Dokumenten.

Dies bietet eine Möglichkeit, eine Obergrenze für die Anzahl der zu scannenden Dokumente festzulegen, um Latenz und Kosten zu begrenzen.

„Nicht angegeben“ wird als keine Grenze interpretiert.

Allgemeines Beispiel:

AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

Benötigt:

• Muss größer als null sein, sofern vorhanden.

FieldReference

Das Feld, für das die Daten aggregiert werden sollen.

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.

CollectionSelector

Die abzufragenden Sammlungen.

Filter

Der Filter, der angewendet werden soll.

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 order_by ist erforderlich, um auf alle Felder zu verweisen, die mit einem Ungleichheitsfilter verwendet werden.
• Alle Felder, die im order_by 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

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.

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.

int32

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.

Int32Value

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.

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.

string

Die Sammlungs-ID. Wenn festgelegt, werden nur Sammlungen mit dieser ID ausgewählt.

bool

Bei „false“ werden nur Sammlungen ausgewählt, die der parent, die in der enthaltenden RunQueryRequest angegeben sind, unmittelbar untergeordnet sind. Bei „true“ werden alle untergeordneten Sammlungen ausgewählt.

Operator

Der Operator zum Kombinieren mehrerer Filter.

Filter

Die Liste der zu kombinierenden Filter.

Benötigt:

• Mindestens ein Filter ist vorhanden.

FieldReference

Das Feld, nach dem gefiltert werden soll.

Operator

Operator, nach dem gefiltert werden soll.

Value

Wert, mit dem verglichen werden soll

string

Ein Verweis auf ein Feld in einem Dokument.

Benötigt:

• MUSS ein durch Punkte getrennter String (.) sein, wobei jedes Segment den Einschränkungen von document field name entspricht.

CompositeFilter

Zusammengesetzter Filter

FieldFilter

Ein Filter für ein Dokumentfeld.

UnaryFilter

Ein Filter, der genau ein Argument annimmt.

FieldReference

Erforderlich. Ein indexiertes Vektorfeld, nach dem gesucht werden soll. Es können nur Dokumente zurückgegeben werden, die Vektoren enthalten, deren Dimensionalität mit dem query_vector übereinstimmt.

Value

Erforderlich. Der Abfragevektor, nach dem gesucht wird. Darf ein Vektor mit maximal 2.048 Dimensionen sein.

DistanceMeasure

Erforderlich. Die zu verwendende Distanzmessung (erforderlich).

Int32Value

Erforderlich. Die Anzahl der nächsten Nachbarn, die zurückgegeben werden sollen. Muss eine positive Ganzzahl bis 1.000 sein.

FieldReference

Das Feld, nach dem sortiert werden soll.

Direction

Die Richtung, nach der sortiert werden soll. Die Standardeinstellung ist ASCENDING.

FieldReference

Die zurückzugebenden Felder.

Wenn leer, werden alle Felder zurückgegeben. Um nur den Namen des Dokuments zurückzugeben, verwenden Sie ['__name__'].

Operator

Der anzuwendende unäre Operator.

FieldReference

Das Feld, auf das der Operator angewendet werden soll.

int32

Die Ziel-ID, die das Ziel im Stream identifiziert. Muss eine positive Zahl sein, die nicht null ist.

Wenn target_id 0 (oder nicht angegeben) ist, weist der Server diesem Ziel eine ID zu und gibt diese in einem TargetChange::ADD-Ereignis zurück. Sobald ein Ziel mit target_id=0 hinzugefügt wird, müssen alle nachfolgenden Ziele ebenfalls die target_id=0 haben. Wenn eine AddTarget-Anfrage mit target_id != 0 an den Server gesendet wird, nachdem ein Ziel mit target_id=0 hinzugefügt wurde, sendet der Server sofort eine Antwort mit einem TargetChange::Remove-Ereignis.

Wenn der Client mehrere AddTarget-Anfragen ohne ID sendet, ist die Reihenfolge der in TargetChage.target_ids zurückgegebenen IDs nicht definiert. Daher sollten Clients eine Ziel-ID bereitstellen, anstatt sich darauf zu verlassen, dass der Server eine Ziel-ID zuweist.

Wenn target_id ungleich null ist, darf in diesem Stream kein aktives Ziel mit derselben ID vorhanden sein.

bool

Ob das Ziel entfernt werden sollte, sobald es aktuell und konsistent ist.

Int32Value

Die Anzahl der Dokumente, die beim Lebenslauftoken oder der Lesezeit zuletzt mit der Abfrage übereinstimmten.

Dieser Wert ist nur relevant, wenn resume_type angegeben wird. Wenn dieser Wert vorhanden ist und größer als null ist, signalisiert der Kunde, dass ExistenceFilter.unchanged_names in der Antwort enthalten sein soll.

QueryTarget

Ein durch eine Abfrage angegebenes Ziel.

DocumentsTarget

Ein Ziel, das durch eine Reihe von Dokumentnamen angegeben wird.

bytes

Ein Fortsetzungstoken aus einem früheren TargetChange für ein identisches Ziel.

Die Verwendung eines Lebenslauftokens mit einem anderen Ziel wird nicht unterstützt und kann fehlschlagen.

Timestamp

Wiedergabe nach einem bestimmten read_time starten.

Der Client muss den Status der übereinstimmenden Dokumente zu diesem Zeitpunkt kennen.

string

Die Namen der abzurufenden Dokumente. Im Format: projects/{project_id}/databases/{database_id}/documents/{document_path}. Die Anfrage schlägt fehl, wenn eines der Dokumente keine untergeordnete Ressource des angegebenen database ist. Doppelte Namen werden entfernt.

string

Der Name der übergeordneten Ressource. Im Format: projects/{project_id}/databases/{database_id}/documents oder projects/{project_id}/databases/{database_id}/documents/{document_path}. Beispiel: projects/my-project/databases/my-database/documents oder projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

StructuredQuery

Eine strukturierte Abfrage.

TargetChangeType

Die Art der durchgeführten Änderung.

int32

Die Ziel-IDs von Zielen, die sich geändert haben.

Wenn das Feld leer ist, wird die Änderung für alle Ziele übernommen.

Die Reihenfolge der Ziel-IDs ist nicht definiert.

Status

Der Fehler, der zu dieser Änderung geführt hat, falls zutreffend.

bytes

Ein Token, mit dem der Stream für die angegebene target_ids oder für alle Ziele fortgesetzt werden kann, wenn target_ids leer ist.

Wird nicht bei jeder Zieländerung festgelegt.

Timestamp

Die konsistente read_time für die angegebene target_ids (ausgelassen, wenn sich die target_ids nicht zu einem konsistenten Snapshot befinden).

Der Stream sendet garantiert einen read_time, bei dem target_ids leer ist, wenn der gesamte Stream einen neuen konsistenten Snapshot erreicht. Nachrichten vom Typ ADD, CURRENT und RESET führen (letztendlich) garantiert zu einem neuen konsistenten Snapshot, Nachrichten vom Typ NO_CHANGE und REMOVE nicht.

Für einen bestimmten Stream erhöht sich read_time garantiert kontinuierlich.

ReadOnly

Die Transaktion kann nur für Lesevorgänge verwendet werden.

ReadWrite

Die Transaktion kann sowohl für Lese- als auch für Schreibvorgänge verwendet werden.

Timestamp

Liest Dokumente zum angegebenen Zeitpunkt.

Dabei muss es sich um einen Zeitstempel mit einer Genauigkeit von Mikrosekunden innerhalb der letzten Stunde handeln. Wenn die Wiederherstellung zu einem bestimmten Zeitpunkt aktiviert ist, kann zusätzlich ein Zeitstempel einer ganzen Minute innerhalb der letzten 7 Tage angegeben werden.

bytes

Eine optionale Transaktion, die wiederholt werden soll.

Document

Erforderlich. Das aktualisierte Dokument. Erstellt das Dokument, falls es noch nicht vorhanden ist.

DocumentMask

Die zu aktualisierenden Felder. Keiner der Feldpfade in der Maske darf einen reservierten Namen enthalten.

Wenn das Dokument auf dem Server vorhanden ist und Felder enthält, auf die in der Maske nicht verwiesen wird, bleiben diese unverändert. Felder, auf die in der Maske verwiesen wird, die im Eingabedokument aber nicht vorhanden sind, werden auf dem Server aus dem Dokument gelöscht.

DocumentMask

Die zurückzugebenden Felder. Wenn nicht festgelegt, werden alle Felder zurückgegeben.

Wenn das Dokument ein Feld enthält, das in dieser Maske nicht vorhanden ist, wird dieses Feld nicht in der Antwort zurückgegeben.

Precondition

Eine optionale Vorbedingung für das Dokument. Die Anfrage schlägt fehl, wenn dies festgelegt und vom Zieldokument nicht erfüllt wird.

NullValue

Ein Nullwert.

bool

Ein boolescher Wert.

int64

Ein ganzzahliger Wert.

double

Ein Double-Wert.

Timestamp

Ein Zeitstempelwert.

Auf Mikrosekunden genau. Beim Speichern wird jede zusätzliche Genauigkeit abgerundet.

string

Ein Stringwert.

Der als UTF-8-String dargestellte String darf 1 MiB und 89 Byte nicht überschreiten. Nur die ersten 1.500 Byte der UTF-8-Darstellung werden von Abfragen berücksichtigt.

bytes

Ein Byte-Wert.

Darf 1 MiB bis 89 Byte nicht überschreiten. Nur die ersten 1.500 Byte werden von Abfragen berücksichtigt.

string

Ein Verweis auf ein Dokument. Beispiel: projects/{project_id}/databases/{database_id}/documents/{document_path}.

LatLng

Ein Geopunktwert, der einen Punkt auf der Erdoberfläche darstellt.

ArrayValue

Ein Arraywert.

Darf nicht direkt einen anderen Arraywert enthalten, kann jedoch eine Karte enthalten, die ein anderes Array enthält.

MapValue

Ein Kartenwert.

DocumentMask

Die Felder, die in diesem Schreibvorgang aktualisiert werden sollen.

Dieses Feld kann nur festgelegt werden, wenn der Vorgang update ist. Wenn die Maske nicht für update festgelegt ist und das Dokument vorhanden ist, werden alle vorhandenen Daten überschrieben. Wenn die Maske festgelegt ist und das Dokument auf dem Server Felder enthält, die nicht von der Maske abgedeckt sind, bleiben diese unverändert. Felder, auf die in der Maske verwiesen wird, die im Eingabedokument aber nicht vorhanden sind, werden auf dem Server aus dem Dokument gelöscht. Die Feldpfade in dieser Maske dürfen keinen reservierten Feldnamen enthalten.

FieldTransform

Die Transformationen, die nach der Aktualisierung ausgeführt werden sollen.

Dieses Feld kann nur festgelegt werden, wenn der Vorgang update ist. Falls vorhanden, entspricht dieser Schreibvorgang der Ausführung von update und transform im selben Dokument in kleinstmöglicher Reihenfolge.

Precondition

Eine optionale Vorbedingung für das Dokument.

Der Schreibvorgang schlägt fehl, wenn dies festgelegt und vom Zieldokument nicht erfüllt wird.

Document

Ein zu schreibendes Dokument.

string

Der Name des zu löschenden Dokuments. Im Format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentTransform

Wendet eine Transformation auf ein Dokument an.

string

Erforderlich. Der Datenbankname. Im Format: projects/{project_id}/databases/{database_id}. Dies ist nur in der ersten Nachricht erforderlich.

string

Die ID des Schreibstreams, der fortgesetzt werden soll. Dies kann nur in der ersten Nachricht festgelegt werden. Wenn das Feld leer ist, wird ein neuer Schreibstream erstellt.

Write

Die anzuwendenden Schreibvorgänge.

Immer atomar und in der richtigen Reihenfolge ausgeführt. Dieses Feld muss in der ersten Anfrage leer sein. Dieses Feld kann in der letzten Anfrage leer sein. Dieses Feld darf nicht bei allen anderen Anfragen leer sein.

bytes

Ein Streamtoken, das zuvor vom Server gesendet wurde.

Der Client sollte dieses Feld auf das Token der letzten erhaltenen WriteResponse festlegen. Damit wird bestätigt, dass der Client Antworten bis zu diesem Token erhalten hat. Nach dem Senden dieses Tokens können frühere Tokens nicht mehr verwendet werden.

Der Server schließt den Stream möglicherweise, wenn zu viele nicht bestätigte Antworten vorhanden sind.

Lass dieses Feld beim Erstellen eines neuen Streams leer. Wenn Sie einen Stream an einer bestimmten Stelle fortsetzen möchten, legen Sie dieses Feld und das Feld stream_id fest.

Lass dieses Feld beim Erstellen eines neuen Streams leer.

map<string, string>

Labels, die mit dieser Schreibanfrage verknüpft sind.

string

Die ID des Streams. Wird nur bei der ersten Nachricht festgelegt, wenn ein neuer Stream erstellt wurde.

bytes

Ein Token, das die Position dieser Antwort im Stream darstellt. Damit kann ein Client den Stream an dieser Stelle fortsetzen.

Dieses Feld ist immer festgelegt.

WriteResult

Das Ergebnis der Anwendung der Schreibvorgänge.

Dieses i-te Schreibergebnis entspricht dem i-ten Schreibvorgang in der Anfrage.

Timestamp

Der Zeitpunkt, zu dem der Commit ausgeführt wurde. Jeder Lesevorgang mit einem gleichen oder größeren Wert für read_time erkennt garantiert die Auswirkungen des Schreibvorgangs.

Timestamp

Der Zeitpunkt der letzten Aktualisierung des Dokuments nach dem Anwenden des Schreibvorgangs. Nicht nach delete festgelegt.

Wenn das Dokument durch den Schreibvorgang nicht geändert wurde, ist dies die vorherige update_time.

Value

Die Ergebnisse der Anwendung der einzelnen DocumentTransform.FieldTransform in derselben Reihenfolge.