Method: projects.databases.exportDocuments

Esporta una copia di tutti i documenti o di un sottoinsieme di documenti da Google Cloud Firestore a un altro sistema di archiviazione, come Google Cloud Storage. I recenti aggiornamenti ai documenti potrebbero non essere visualizzati nell'esportazione. L'esportazione avviene in background e il suo avanzamento può essere monitorato e gestito tramite la risorsa Operazione creata. L'output di un'esportazione può essere utilizzato solo al termine dell'operazione associata. Se un'operazione di esportazione viene annullata prima del completamento, potrebbe lasciare dei dati parziali in Google Cloud Storage.

Per maggiori dettagli sul comportamento di esportazione e sul formato dell'output, consulta: https://cloud.google.com/firestore/docs/manage-data/export-import

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatoria. Database da esportare. Deve essere nel formato: projects/{projectId}/databases/{databaseId}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string,
  "namespaceIds": [
    string
  ],
  "snapshotTime": string
}
Campi
collectionIds[]

string

Quali ID raccolta esportare. Non specificati indica tutte le raccolte.
outputUriPrefix

string

L'URI di output. Attualmente supporta solo gli URI Google Cloud Storage nel formato gs://BUCKET_NAME[/NAMESPACE_PATH], dove BUCKET_NAME è il nome del bucket Google Cloud Storage e NAMESPACE_PATH è un percorso facoltativo dello spazio dei nomi di Google Cloud Storage. Quando scegli un nome, assicurati di tenere in considerazione le linee guida di Google Cloud Storage per la denominazione: https://cloud.google.com/storage/docs/naming. Se l'URI è un bucket (senza un percorso dello spazio dei nomi), verrà generato un prefisso in base all'ora di inizio.
namespaceIds[]

string

Un elenco vuoto rappresenta tutti gli spazi dei nomi. Questo è l'utilizzo preferito per i database che non utilizzano spazi dei nomi.

Una stringa vuota rappresenta lo spazio dei nomi predefinito. Questa opzione deve essere utilizzata se il database contiene dati in spazi dei nomi non predefiniti, ma non vuole includerli. Ogni spazio dei nomi in questo elenco deve essere univoco.
snapshotTime

string (Timestamp format)

Il timestamp corrispondente alla versione del database da esportare. Il timestamp deve essere nel passato, arrotondato al minuto e non anteriore a earliestVersionTime. Se specificato, i documenti esportati rappresenteranno una visualizzazione coerente del database al momento specificato. In caso contrario, non vi sono garanzie sulla coerenza dei documenti esportati.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Operation.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.