Method: projects.databases.exportDocuments

Экспортирует копию всех документов или их части из Google Cloud Firestore в другую систему хранения, например Google Cloud Storage. Недавние обновления документов могут не быть отражены при экспорте. Экспорт происходит в фоновом режиме, и его ход можно отслеживать и управлять с помощью созданного ресурса Operation. Вывод экспорта можно использовать только после завершения соответствующей операции. Если операция экспорта отменена до завершения, в облачном хранилище Google могут остаться частичные данные.

Более подробную информацию о поведении экспорта и формате вывода см. на странице https://cloud.google.com/firestore/docs/manage-data/export-import .

HTTP-запрос

POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*}:exportDocuments

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
name

string

Необходимый. База данных для экспорта. Должен иметь форму: projects/{projectId}/databases/{databaseId} .

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string,
  "namespaceIds": [
    string
  ],
  "snapshotTime": string
}
Поля
collectionIds[]

string

Идентификаторы каких коллекций экспортировать. Не указано означает все коллекции.

outputUriPrefix

string

Выходной URI. В настоящее время поддерживаются только URI Google Cloud Storage в форме: gs://BUCKET_NAME[/NAMESPACE_PATH] , где BUCKET_NAME — это имя сегмента Google Cloud Storage, а NAMESPACE_PATH — необязательный путь к пространству имен Google Cloud Storage. При выборе имени обязательно учитывайте рекомендации по присвоению имен Google Cloud Storage: https://cloud.google.com/storage/docs/naming . Если URI представляет собой сегмент (без пути в пространстве имен), префикс будет создан на основе времени начала.

namespaceIds[]

string

Пустой список представляет все пространства имен. Это предпочтительное использование для баз данных, которые не используют пространства имен.

Пустой строковый элемент представляет пространство имен по умолчанию. Это следует использовать, если база данных имеет данные в пространствах имен, отличных от заданных по умолчанию, но не хочет их включать. Каждое пространство имен в этом списке должно быть уникальным.

snapshotTime

string ( Timestamp format)

Временная метка, соответствующая версии экспортируемой базы данных. Временная метка должна быть в прошлом, округлена до минуты и не старше, чем earliestVersionTime . Если указано, то экспортированные документы будут представлять собой согласованное представление базы данных в указанное время. В противном случае нет никаких гарантий относительно целостности экспортируемых документов.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

Тело ответа

В случае успеха тело ответа содержит экземпляр Operation .

Области авторизации

Требуется одна из следующих областей OAuth:

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

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