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 nos documentos podem não aparecer na exportação. A exportação ocorre em segundo plano, e o progresso dela pode ser monitorado e gerenciado pelo recurso "Operação" criado. Só é possível usar a saída de uma exportação depois que a operação associada é concluída. Se uma operação de exportação for cancelada antes da conclusão, é possível que dados parciais sejam deixados para trás no Google Cloud Storage.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
name

string

Banco de dados a ser exportado. Precisa estar no formato: projects/{projectId}/databases/{databaseId}.

Corpo da solicitação

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

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

string

Quais códigos de coleção exportar. Não especificado significa todas as coleções.
outputUriPrefix

string

O URI de saída. Atualmente, só aceita URIs do Google Cloud Storage no formato: gs://BUCKET_NAME[/NAMESPACE_PATH], em que BUCKET_NAME é o nome do bucket do Google Cloud Storage e NAMESPACE_PATH é um caminho de namespace opcional do Google Cloud Storage. Ao escolher um nome, considere as diretrizes de nomenclatura do Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Se o URI for um bucket sem um caminho de namespace, um prefixo será gerado com base no horário de início.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.