Method: projects.databases.exportDocuments

Exporta una copia de todos los documentos o de un subconjunto de ellos 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 realiza en segundo plano y su progreso se puede supervisar y administrar a través del recurso de operación que se crea. El resultado de una exportación solo se puede usar después de que se complete la operación asociada. Si se cancela una operación de exportación antes de completarse, es posible que se conserven datos parciales en Google Cloud Storage.

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

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. 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

Los IDs de colección que se exportarán. Si no se especifica, se incluirán todas las colecciones.
outputUriPrefix

string

El URI de salida. Actualmente, solo admite URI de Google Cloud Storage con el formato gs://BUCKET_NAME[/NAMESPACE_PATH], en el que BUCKET_NAME es el nombre del bucket de Google Cloud Storage y NAMESPACE_PATH es una ruta de espacio de nombres opcional de Google Cloud Storage. Cuando elijas un nombre, asegúrate de tener en cuenta los lineamientos para asignar nombres de Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Si el URI es un bucket (sin una ruta de espacio de nombres), se generará un prefijo en función de la hora de inicio.
namespaceIds[]

string

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

Un elemento de string vacía representa el espacio de nombres predeterminado. Se debe usar si la base de datos tiene datos en espacios de nombres no predeterminados, pero no desea incluirlos. Cada espacio de nombres de 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 exportará. La marca de tiempo debe ser antigua, redondeada al minuto y no anterior a 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 “Zulú”, 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 la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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