Method: projects.databases.exportDocuments

Exporta una copia de todos o un subconjunto de documentos de Google Cloud Firestore a otro sistema de almacenamiento, como Google Cloud Storage. Es posible que las actualizaciones recientes de los documentos no se reflejen en la exportación. La exportación se produce en segundo plano y su progreso se puede monitorear y administrar a través del recurso Operación que se crea. El resultado de una exportación sólo podrá utilizarse una vez realizada la operación asociada. Si una operación de exportación se cancela antes de completarse, es posible que queden datos parciales en Google Cloud Storage.

Para obtener más detalles sobre el comportamiento de exportación y el formato de salida, consulte: https://cloud.google.com/firestore/docs/manage-data/export-import

solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación gRPC .

Parámetros de ruta

Parámetros
name

string

Requerido. Base de datos para exportar. Debe tener el formato: projects/{projectId}/databases/{databaseId} .

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string,
  "namespaceIds": [
    string
  ],
  "snapshotTime": string
}
Campos
collectionIds[]

string

Qué ID de colección exportar. Sin especificar significa todas las colecciones.

outputUriPrefix

string

El URI de salida. Actualmente solo admite URI de Google Cloud Storage del formato: gs://BUCKET_NAME[/NAMESPACE_PATH] , donde BUCKET_NAME es el nombre del depósito de Google Cloud Storage y NAMESPACE_PATH es una ruta de espacio de nombres opcional de Google Cloud Storage. Al elegir un nombre, asegúrese de considerar las pautas de nomenclatura de Google Cloud Storage: https://cloud.google.com/storage/docs/naming . Si el URI es un depósito (sin una ruta de espacio de nombres), se generará un prefijo según la hora de inicio.

namespaceIds[]

string

Una lista vacía representa todos los espacios de nombres. Este es el uso preferido para bases de datos que no utilizan espacios de nombres.

Un elemento de cadena vacío representa el espacio de nombres predeterminado. Esto debe usarse si la base de datos tiene datos en espacios de nombres no predeterminados, pero no desea incluirlos. Cada espacio de nombres en esta lista debe ser único.

snapshotTime

string ( Timestamp format)

La marca de tiempo que corresponde a la versión de la base de datos que se va a exportar. La marca de tiempo debe estar en el pasado, redondeada al minuto y no ser anterior a la versión más temprana de earliestVersionTime . Si se especifica, los documentos exportados representarán una vista coherente de la base de datos en el momento proporcionado. De lo contrario, no hay garantías sobre la coherencia de los documentos exportados.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .

Cuerpo de respuesta

Si tiene éxito, el cuerpo de la respuesta contiene una instancia de Operation .

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

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

Para obtener más información, consulte Descripción general de la autenticación .