Method: projects.databases.documents.batchWrite

쓰기 작업을 일괄 적용합니다.

문서.batchWrite 메서드는 쓰기 작업을 원자적으로 적용하지 않으며 잘못된 순서로 적용할 수 있습니다. 메서드가 문서당 둘 이상의 쓰기를 허용하지 않습니다. 각 쓰기는 독립적으로 성공하거나 실패합니다. 각 쓰기의 성공 상태는 BatchWriteResponse를 참조하세요.

원자적으로 적용되는 쓰기 세트가 필요한 경우 대신 documents.commit를 사용하세요.

HTTP 요청

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

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
database

string

필수 항목입니다. 데이터베이스 이름입니다. 형식은 projects/{projectId}/databases/{databaseId}입니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
필드
writes[]

object (Write)

적용할 쓰기입니다.

메서드는 쓰기를 원자적으로 적용하지 않으며 순서를 보장하지 않습니다. 각 쓰기는 독립적으로 성공하거나 실패합니다. 동일한 문서에 요청당 두 번 이상 작성할 수 없습니다.
labels

map (key: string, value: string)

이 일괄 쓰기와 연결된 라벨입니다.

"key": value 쌍 목록을 포함하는 객체입니다. 예를 들면 { "name": "wrench", "mass": "1.3kg", "count": "3" }입니다.

응답 본문

Firestore.BatchWrite의 응답

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
필드
writeResults[]

object (WriteResult)

쓰기를 적용한 결과입니다.

이 i번째 쓰기 결과는 요청의 i번째 쓰기에 해당합니다.
status[]

object (Status)

쓰기 적용 상태입니다.

이 i번째 쓰기 상태는 요청의 i번째 쓰기에 해당합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 인증 개요를 참조하세요.