Method: projects.databases.documents.batchWrite

Wendet einen Batch von Schreibvorgängen an.

Die Methode „documents.batchWrite“ wendet die Schreibvorgänge nicht in kleinstmöglichen Schritten an und kann sie in falscher Reihenfolge anwenden. Die Methode lässt nicht mehr als einen Schreibvorgang pro Dokument zu. Jeder Schreibvorgang ist unabhängig voneinander erfolgreich oder schlägt fehl. Den Erfolgsstatus jedes Schreibvorgangs finden Sie unter BatchWriteResponse.

Wenn Sie einen atomar angewendeten Satz von Schreibvorgängen benötigen, verwenden Sie stattdessen documents.commit.

HTTP-Anfrage

POST https://firestore.googleapis.com/v1/{database=projects/*/databases/*}/documents:batchWrite

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
database

string

Erforderlich. Der Datenbankname. Im Format: projects/{projectId}/databases/{databaseId}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
Felder
writes[]

object (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.
labels

map (key: string, value: string)

Labels, die mit diesem Batchschreibvorgang verknüpft sind.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Antworttext

Die Antwort von Firestore.BatchWrite.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
Felder
writeResults[]

object (WriteResult)

Das Ergebnis der Anwendung der Schreibvorgänge.

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

object (Status)

Der Status der Anwendung der Schreibvorgänge.

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

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.