Method: projects.databases.documents.batchWrite

Stosuje grupę operacji zapisu.

Metoda document.batchWrite nie stosuje atomowo operacji zapisu i może zastosować je w podanej kolejności. Metoda nie pozwala na więcej niż jeden zapis na dokument. Każdy zapis jest sprawdzany lub kończy się niepowodzeniem niezależnie. Informacje o stanie powodzenia każdego zapisu znajdziesz w sekcji BatchWriteResponse.

Jeśli potrzebujesz atomowego zestawu zapisów, użyj zamiast tego documents.commit.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
database

string

Wymagane. Nazwa bazy danych. W formacie: projects/{projectId}/databases/{databaseId}.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

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

object (Write)

Zapisy, które mają zostać zastosowane.

Metoda nie stosuje atomowych zapisów i nie gwarantuje kolejności. Każdy zapis jest sprawdzany lub kończy się niepowodzeniem niezależnie. Nie możesz zapisać w tym samym dokumencie więcej niż raz na jedno żądanie.
labels

map (key: string, value: string)

Etykiety powiązane z tym zapisem wsadowym.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Treść odpowiedzi

Odpowiedź od użytkownika Firestore.BatchWrite.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
Pola
writeResults[]

object (WriteResult)

Wynik zastosowania zapisów.

Ten wynik i-tego zapisu odpowiada i-temu zapisowi w żądaniu.
status[]

object (Status)

Stan zastosowania zapisów.

Ten stan i-tego zapisu odpowiada i-temu zapisowi w żądaniu.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).