Stosuje grupę operacji zapisu.
Metoda Document.batchWrite nie stosuje atomów do operacji zapisu i może je stosować w złej kolejności. Metoda nie pozwala na więcej niż 1 zapis w dokumencie. Każdy zapis kończy się sukcesem lub niepowodzeniem. Informacje o stanie powodzenia każdego zapisu znajdziesz w sekcji BatchWriteResponse
.
Jeśli potrzebujesz zestawu zapisów stosowanych atomowo, użyj documents.commit
.
Żądanie HTTP
POST https://firestore.googleapis.com/v1beta1/{database=projects/*/databases/*}/documents:batchWrite
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
database |
Wymagane. Nazwa bazy danych. W formacie: |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"writes": [
{
object ( |
Pola | |
---|---|
writes[] |
Zapisy do zastosowania. Metoda nie stosuje się do zapisu atomowego i nie gwarantuje kolejności. Każdy zapis kończy się sukcesem lub niepowodzeniem. W danym żądaniu nie można zapisać w tym samym dokumencie więcej niż jeden raz. |
labels |
Etykiety powiązane z tym zapisem wsadowym. Obiekt zawierający listę par |
Treść odpowiedzi
Odpowiedź od użytkownika Firestore.BatchWrite
.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "writeResults": [ { object ( |
Pola | |
---|---|
writeResults[] |
Wynik zastosowania zapisów. Ten i-ty wynik zapisu odpowiada i-temu zapisowi w żądaniu. |
status[] |
Stan stosowania zapisów. Ten stan i-tego zapisu odpowiada i-temu zapisowi w żądaniu. |
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.