Method: projects.databases.exportDocuments

Exporta uma cópia de todos ou um subconjunto de documentos do Google Cloud Firestore para outro sistema de armazenamento, como o Google Cloud Storage. As atualizações recentes de documentos podem não ser refletidas na exportação. A exportação ocorre em segundo plano e seu andamento pode ser monitorado e gerenciado por meio do recurso Operação que é criado. A saída de uma exportação só pode ser usada depois que a operação associada for concluída. Se uma operação de exportação for cancelada antes da conclusão, ela pode deixar dados parciais no Google Cloud Storage.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. Banco de dados para exportar. Deve estar no formato: projects/{project_id}/databases/{databaseId} .

Solicitar corpo

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string
}
Campos
collectionIds[]

string

Quais IDs de coleção exportar. Não especificado significa todas as coleções.

outputUriPrefix

string

O URI de saída. Atualmente suporta apenas URIs do Google Cloud Storage no formato: gs://BUCKET_NAME[/NAMESPACE_PATH] , em que BUCKET_NAME é o nome do BUCKET_NAME do Google Cloud Storage e NAMESPACE_PATH é um caminho opcional do namespace do Google Cloud Storage. Ao escolher um nome, certifique-se de considerar as diretrizes de nomenclatura do Google Cloud Storage: https://cloud.google.com/storage/docs/naming . Se o URI for um depósito (sem um caminho de namespace), um prefixo será gerado com base na hora de início.

Corpo de resposta

Se for bem-sucedido, o corpo da resposta conterá uma instância de Operation .

Escopos de Autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .