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 ocurre en segundo plano y su progreso se puede monitorear y administrar a través del recurso Operación que se crea. La salida de una exportación solo se puede utilizar una vez que se realiza la operación asociada. Si una operación de exportación se cancela antes de completarse, puede dejar datos parciales en Google Cloud Storage.

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/{project_id}/databases/{databaseId} .

Cuerpo de la solicitud

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

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

string

Qué identificadores de colección exportar. Sin especificar significa 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] , donde BUCKET_NAME es el nombre del depósito de Google Cloud Storage y NAMESPACE_PATH es una ruta de espacio de nombres de Google Cloud Storage opcional. Al elegir un nombre, asegúrese de tener en cuenta 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 en función de la hora de inicio.

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 la descripción general de la autenticación .