Method: projects.databases.exportDocuments

Exporta uma cópia de todos ou de um subconjunto de documentos do Google Cloud Firestore para outro sistema de armazenamento, como o Google Cloud Storage. As atualizações recentes dos 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 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, poderá deixar dados parciais no Google Cloud Storage.

Para obter mais detalhes sobre o comportamento de exportação e 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

A URL usa 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/{projectId}/databases/{databaseId} .

Solicitar corpo

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[]

string

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

outputUriPrefix

string

O URI de saída. Atualmente, só é compatível com URIs do Google Cloud Storage no formato: gs://BUCKET_NAME[/NAMESPACE_PATH] , em que BUCKET_NAME é o nome do intervalo do Google Cloud Storage e NAMESPACE_PATH é um caminho opcional do namespace 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 caminho de namespace), um prefixo será gerado com base na hora de início.

namespaceIds[]

string

Uma lista vazia representa todos os namespaces. Este é o uso preferencial para bancos de dados que não usam namespaces.

Um elemento de string vazio representa o namespace padrão. Deve ser usado se o banco de dados tiver dados em namespaces não padrão, mas não quiser incluí-los. Cada namespace nesta lista deve ser exclusivo.

snapshotTime

string ( Timestamp format)

O carimbo de data/hora que corresponde à versão do banco de dados a ser exportado. O carimbo de data/hora deve estar no passado, arredondado para o minuto e não ser anterior a earliestVersionTime . Se especificado, os documentos exportados representarão uma visão consistente do banco de dados no momento fornecido. Caso contrário, não há garantias quanto à consistência dos documentos exportados.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z" .

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 .