Method: projects.databases.documents.batchWrite

Применяет пакет операций записи.

Метод document.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

Для получения дополнительной информации см. Обзор аутентификации .