Method: projects.databases.documents.batchWrite

Applica un gruppo di operazioni di scrittura.

Il metodo documents.batchWrite non applica le operazioni di scrittura a livello atomico e può applicarle in modo ordinario. Il metodo non consente più di una scrittura per documento. Ogni scrittura ha esito positivo o negativo in modo indipendente. Consulta il BatchWriteResponse per lo stato di ogni scrittura.

Se hai bisogno di un set di scritture applicate a livello atomico, utilizza invece documents.commit.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
database

string

Obbligatoria. Il nome del database. Nel formato: projects/{projectId}/databases/{databaseId}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
Campi
writes[]

object (Write)

Le operazioni di scrittura da applicare.

Il metodo non si applica a livello atomico e non garantisce l'ordinamento. Ogni scrittura ha esito positivo o negativo in modo indipendente. Non puoi scrivere sullo stesso documento più di una volta per richiesta.
labels

map (key: string, value: string)

Etichette associate alla scrittura in batch.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Corpo della risposta

La risposta di Firestore.BatchWrite.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
Campi
writeResults[]

object (WriteResult)

Il risultato dell'applicazione delle scritture.

Questo risultato di scrittura i-th corrisponde alla scrittura i-esima nella richiesta.
status[]

object (Status)

Lo stato delle scritture.

Questo stato di scrittura i-esima corrisponde alla scrittura i-esima nella richiesta.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.