projects.databases.exportDocuments: Exports a copy of all or a subset of documents from Google...

View source: R/firestore_functions.R

projects.databases.exportDocumentsR Documentation

Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import

Description

Autogenerated via gar_create_api_skeleton

Usage

projects.databases.exportDocuments(
  GoogleFirestoreAdminV1ExportDocumentsRequest,
  name
)

Arguments

GoogleFirestoreAdminV1ExportDocumentsRequest

The GoogleFirestoreAdminV1ExportDocumentsRequest object to pass to this method

name

Required

Details

Authentication scopes used by this function are:

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

  • https://www.googleapis.com/auth/datastore

Set options(googleAuthR.scopes.selected = c(https://www.googleapis.com/auth/cloud-platform, https://www.googleapis.com/auth/datastore) Then run googleAuthR::gar_auth() to authenticate. See gar_auth for details.

See Also

Google Documentation

Other GoogleFirestoreAdminV1ExportDocumentsRequest functions: GoogleFirestoreAdminV1ExportDocumentsRequest()


robonomist/googleFirestore documentation built on Jan. 30, 2023, 6:39 p.m.