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.
Para saber mais sobre o comportamento de exportação e o formato de saída, consulte: https://cloud.google.com/firestore/docs/manage-data/export-import
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 |
Obrigatório. Banco de dados a ser exportado. Precisa estar no formato: |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "collectionIds": [ string ], "outputUriPrefix": string, "namespaceIds": [ string ], "snapshotTime": string } |
Campos | |
---|---|
collectionIds[] |
Quais códigos de coleção exportar. Não especificado significa todas as coleções. |
outputUriPrefix |
O URI de saída. Atualmente, só aceita URIs do Google Cloud Storage no formato: |
namespaceIds[] |
Uma lista vazia representa todos os namespaces. Esse é o uso preferencial para bancos de dados que não usam namespaces. Um elemento de string vazio representa o namespace padrão. Use se o banco de dados tiver dados em namespaces não padrão, mas você não quiser incluí-los. Cada namespace dessa lista precisa ser exclusivo. |
snapshotTime |
O carimbo de data/hora que corresponde à versão do banco de dados a ser exportado. O carimbo de data/hora precisa estar no passado, arredondado para os minutos e não pode ser anterior a Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
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.