Esporta e importa dati

Puoi utilizzare il servizio di esportazione e importazione gestita di Cloud Firestore per eseguire il ripristino dall'eliminazione accidentale dei dati ed esportare i dati per l'elaborazione offline. Puoi esportare tutti i documenti o solo raccolte specifiche. Allo stesso modo, puoi importare tutti i dati da un'esportazione o solo raccolte specifiche. I dati esportati da un database Cloud Firestore possono essere importati in un altro database Cloud Firestore. Puoi anche caricare le esportazioni di Cloud Firestore in BigQuery .

Questa pagina descrive come esportare e importare documenti Cloud Firestore utilizzando il servizio di esportazione e importazione gestito e Cloud Storage . Il servizio di esportazione e importazione gestita di Cloud Firestore è disponibile tramite lo strumento a riga di comando gcloud e l'API di Cloud Firestore ( REST , RPC ).

Prima di iniziare

Prima di poter utilizzare il servizio di esportazione e importazione gestita, è necessario completare le seguenti attività:

1. Abilita la fatturazione per il tuo progetto Google Cloud. Solo i progetti Google Cloud con fatturazione abilitata possono utilizzare la funzionalità di esportazione e importazione.
2. Crea un bucket Cloud Storage per il tuo progetto in una posizione vicina alla posizione del database Cloud Firestore . Non puoi utilizzare un bucket a carico del richiedente per le operazioni di esportazione e importazione.

3. Assicurati che il tuo account disponga delle autorizzazioni necessarie per Cloud Firestore e Cloud Storage. Se sei il proprietario del progetto, il tuo account dispone delle autorizzazioni richieste. In caso contrario, i seguenti ruoli concedono le autorizzazioni necessarie per le operazioni di esportazione e importazione e per l'accesso a Cloud Storage:

   • Ruoli Cloud Firestore: Owner , Cloud Datastore Owner o Cloud Datastore Import Export Admin

   • Ruoli di Cloud Storage: Owner o Storage Admin

Autorizzazioni dell'agente di servizio

Le operazioni di esportazione e importazione utilizzano un agente di servizio Cloud Firestore per autorizzare le operazioni di Cloud Storage. L'agente di servizio Cloud Firestore utilizza la seguente convenzione di denominazione:

Agente di servizio Cloud Firestore

service- PROJECT_NUMBER @gcp-sa-firestore.iam.gserviceaccount.com

Per ulteriori informazioni sugli agenti di servizio, vedere Agenti di servizio .

L'agente di servizio Cloud Firestore richiede l'accesso al bucket Cloud Storage utilizzato in un'operazione di esportazione o importazione. Se il tuo bucket Cloud Storage si trova nello stesso progetto del tuo database Cloud Firestore, l'agente di servizio Cloud Firestore può accedere al bucket per impostazione predefinita .

Se il bucket Cloud Storage si trova in un altro progetto, devi concedere all'agente di servizio Cloud Firestore l'accesso al bucket Cloud Storage.

Assegna ruoli all'agente di servizio

Puoi utilizzare lo strumento da riga di comando gsutil per assegnare uno dei ruoli seguenti. Ad esempio, per assegnare il ruolo Storage Admin all'agente di servizio Cloud Firestore, esegui quanto segue:

gsutil iam ch serviceAccount:service-PROJECT_NUMBER@gcp-sa-firestore.iam.gserviceaccount.com:roles/storage.admin \
    gs://[BUCKET_NAME]

Sostituisci PROJECT_NUMBER con il numero del tuo progetto, utilizzato per assegnare un nome al tuo agente di servizio Cloud Firestore. Per visualizzare il nome dell'agente di servizio, vedere Visualizzare il nome dell'agente di servizio .

In alternativa, puoi assegnare questo ruolo utilizzando la console di GCP .

Visualizza il nome dell'agente di servizio

Puoi visualizzare l'account utilizzato dalle tue operazioni di importazione ed esportazione per autorizzare le richieste dalla pagina Importa/Esporta nella console di Google Cloud Platform. Puoi anche vedere se il tuo database utilizza l'agente di servizio Cloud Firestore o l'account di servizio App Engine precedente.

1. Visualizza l'account di autorizzazione accanto ai processi di importazione/esportazione eseguiti come etichetta.

L'agente di servizio necessita del ruolo Storage Admin per il bucket Cloud Storage da utilizzare per l'operazione di esportazione o importazione.

Configura gcloud per il tuo progetto

Puoi avviare le operazioni di importazione ed esportazione tramite la console di Google Cloud Platform o lo strumento a riga di comando gcloud . Per utilizzare gcloud , configura lo strumento a riga di comando e connettiti al tuo progetto in uno dei seguenti modi:

• Accedi gcloud dalla console di Google Cloud Platform utilizzando Cloud Shell .

  Avvia Cloud Shell

  Assicurati che gcloud sia configurato per il progetto corretto:

  gcloud config set project [PROJECT_ID]
  

• Installa e inizializza Google Cloud SDK.

Esporta dati

Un'operazione di esportazione copia i documenti nel tuo database in un set di file in un bucket Cloud Storage. Si noti che un'esportazione non è un'istantanea del database esatta acquisita all'ora di inizio dell'esportazione. Un'esportazione può includere modifiche apportate durante l'esecuzione dell'operazione.

Esporta tutti i documenti

gcloud firestore export gs://[BUCKET_NAME]

Esporta raccolte specifiche

gcloud firestore export gs://[BUCKET_NAME] --collection-ids=[COLLECTION_ID_1],[COLLECTION_ID_2],[SUBCOLLECTION_ID_1]

Importa dati

Dopo aver esportato i file in Cloud Storage, puoi reimportare i documenti in quei file nel tuo progetto o in un altro progetto. Tenere presente i seguenti punti sulle operazioni di importazione:

• Quando si importano i dati, gli indici richiesti vengono aggiornati utilizzando le definizioni di indice correnti del database. Un'esportazione non contiene definizioni di indice.

• Le importazioni non assegnano nuovi ID documento. Le importazioni utilizzano gli ID acquisiti al momento dell'esportazione. Durante l'importazione di un documento, il suo ID è riservato per evitare conflitti di ID. Se esiste già un documento con lo stesso ID, l'importazione sovrascrive il documento esistente.

• Se un documento nel tuo database non è interessato da un'importazione, rimarrà nel tuo database dopo l'importazione.

• Le operazioni di importazione non attivano Cloud Functions. I listener di snapshot ricevono gli aggiornamenti relativi alle operazioni di importazione.

• Il nome del file .overall_export_metadata deve corrispondere al nome della cartella principale:

  gs://BUCKET_NAME/OPTIONAL_NAMESPACE_PATH/ PARENT_FOLDER_NAME / PARENT_FOLDER_NAME .overall_export_metadata

  Se sposti o copi i file di output di un'esportazione, mantieni lo stesso nome del file PARENT_FOLDER_NAME e .overall_export_metadata .

Importa tutti i documenti da un'esportazione

gcloud firestore import gs://[BUCKET_NAME]/[EXPORT_PREFIX]/

gcloud firestore import gs://exports-bucket/2017-05-25T23:54:39_76544/

Importa raccolte specifiche

gcloud firestore import gs://[BUCKET_NAME]/[EXPORT_PREFIX]/ --collection-ids=[COLLECTION_ID_1],[COLLECTION_ID_2],[SUBCOLLECTION_ID_1]

Gestione delle operazioni di esportazione e importazione

Dopo aver avviato un'operazione di esportazione o importazione, Cloud Firestore assegna all'operazione un nome univoco. È possibile utilizzare il nome dell'operazione per eliminare, annullare o controllare lo stato dell'operazione.

I nomi delle operazioni sono preceduti da projects/[PROJECT_ID]/databases/(default)/operations/ , ad esempio:

projects/my-project/databases/(default)/operations/ASA1MTAwNDQxNAgadGx1YWZlZAcSeWx0aGdpbi1zYm9qLW5pbWRhEgopEg

Tuttavia, puoi omettere il prefisso quando specifichi un nome di operazione per i describe , cancel e delete .

Elenca tutte le operazioni di esportazione e importazione

gcloud firestore operations list

Verificare lo stato dell'operazione

gcloud firestore operations describe [OPERATION_NAME]

Stimare il tempo di completamento

Una richiesta per lo stato di un'operazione a esecuzione prolungata restituisce le metriche workEstimated e workCompleted . Ognuna di queste metriche viene restituita sia in numero di byte che in numero di entità:

• workEstimated mostra il numero totale stimato di byte e documenti che un'operazione elaborerà. Cloud Firestore potrebbe omettere questo parametro se non è in grado di effettuare una stima.

• workCompleted mostra il numero di byte e documenti elaborati finora. Al termine dell'operazione, il valore mostra il numero totale di byte e documenti che sono stati effettivamente elaborati, che potrebbe essere maggiore del valore di workEstimated .

Dividi workCompleted dal workEstimated per una stima approssimativa dei progressi. Questa stima potrebbe essere imprecisa, poiché dipende dalla raccolta ritardata delle statistiche.

Annullare un'operazione

gcloud firestore operations cancel [OPERATION_NAME]

L'annullamento di un'operazione in esecuzione non annulla l'operazione. Un'operazione di esportazione annullata lascerà i documenti già esportati in Cloud Storage e un'operazione di importazione annullata lascerà gli aggiornamenti già apportati al database. Non è possibile importare un'esportazione parzialmente completata.

Elimina un'operazione

Utilizza il comando gcloud firestore operations delete per rimuovere un'operazione dall'elenco delle operazioni recenti. Questo comando non eliminerà i file di esportazione da Cloud Storage.

gcloud firestore operations delete [OPERATION_NAME]

Fatturazione e prezzi per le operazioni di esportazione e importazione

Devi abilitare la fatturazione per il tuo progetto Google Cloud prima di utilizzare il servizio di esportazione e importazione gestita. Le operazioni di esportazione e importazione vengono addebitate per le letture e le scritture dei documenti alle tariffe indicate nei prezzi di Cloud Firestore .

I costi delle operazioni di esportazione e importazione non contano per il limite di spesa . Le operazioni di esportazione o importazione non attiveranno i tuoi avvisi sul budget di Google Cloud fino al completamento. Allo stesso modo, le letture e le scritture eseguite durante un'operazione di esportazione o importazione vengono applicate alla tua quota giornaliera dopo il completamento dell'operazione. Le operazioni di esportazione e importazione non influiranno sull'utilizzo mostrato nella sezione utilizzo della console.

Visualizzazione dei costi di esportazione e importazione

Le operazioni di esportazione e importazione applicano l'etichetta goog-firestoremanaged:exportimport alle operazioni fatturate. Nella pagina dei report Cloud Billing , puoi utilizzare questa etichetta per visualizzare i costi relativi alle operazioni di importazione ed esportazione:

Esporta in BigQuery

Puoi caricare i dati da un'esportazione di Cloud Firestore in BigQuery, ma solo se hai specificato un filtro collection-ids . Consulta Caricamento dei dati dalle esportazioni di Cloud Firestore .

Limite colonna BigQuery

BigQuery impone un limite di 10.000 colonne per tabella. Le operazioni di esportazione di Cloud Firestore generano uno schema di tabella BigQuery per ogni gruppo di raccolta. In questo schema, ogni nome di campo univoco all'interno di un gruppo di raccolta diventa una colonna dello schema.

Se lo schema BigQuery di un gruppo di raccolta supera le 10.000 colonne, l'operazione di esportazione di Cloud Firestore tenta di rimanere al di sotto del limite di colonne trattando i campi della mappa come byte. Se questa conversione porta il numero di colonne al di sotto di 10.000, puoi caricare i dati in BigQuery, ma non puoi eseguire query sui sottocampi all'interno dei campi della mappa. Se il numero di colonne supera ancora 10.000, l'operazione di esportazione non genera uno schema BigQuery per il gruppo di raccolta e non puoi caricarne i dati in BigQuery.

Esporta file di formato e metadati

L'output di un'esportazione gestita utilizza il formato di registro LevelDB .

File di metadati

Un'operazione di esportazione crea un file di metadati per ogni gruppo di raccolta specificato. I file di metadati sono in genere denominati ALL_NAMESPACES_KIND_[COLLECTION_GROUP_ID].export_metadata .

I file di metadati sono buffer di protocollo e puoi decodificarli con il compilatore di protocollo protoc . Ad esempio, puoi decodificare un file di metadati per determinare i gruppi di raccolte contenuti nei file di esportazione:

protoc --decode_raw < export0.export_metadata

Migrazione dell'agente di servizio

Cloud Firestore utilizza un agente di servizio Cloud Firestore per autorizzare le operazioni di importazione ed esportazione invece di utilizzare l'account di servizio App Engine. L'agente di servizio e l'account di servizio utilizzano le seguenti convenzioni di denominazione:

Agente di servizio Cloud Firestore

service- PROJECT_NUMBER @gcp-sa-firestore.iam.gserviceaccount.com

In precedenza, Cloud Firestore utilizzava l'account di servizio predefinito di App Engine anziché l'agente di servizio di Cloud Firestore. Se il tuo database utilizza ancora l'account di servizio App Engine per importare o esportare dati, ti consigliamo di seguire le istruzioni in questa sezione per eseguire la migrazione utilizzando l'agente di servizio Cloud Firestore.

Account di servizio App Engine

PROJECT_ID @appspot.gserviceaccount.com

L'agente di servizio Cloud Firestore è preferibile perché è specifico di Cloud Firestore. L'account di servizio App Engine è condiviso da più di un servizio.

Visualizza l'account di autorizzazione

Puoi visualizzare l'account utilizzato dalle tue operazioni di importazione ed esportazione per autorizzare le richieste dalla pagina Importa/Esporta nella console di Google Cloud Platform. Puoi anche vedere se il tuo database utilizza già l'agente di servizio Cloud Firestore.

1. Vai alla pagina di importazione/esportazione di Cloud Firestore nella console di Google Cloud Platform.

   Vai a Importa/Esporta

2. Visualizza l'account di autorizzazione accanto ai processi di importazione/esportazione eseguiti come etichetta.

Se il tuo progetto non utilizza l'agente di servizio Cloud Firestore, puoi eseguire la migrazione all'agente di servizio Cloud Firestore utilizzando una di queste tecniche:

• Esegui la migrazione di un progetto controllando e aggiornando le autorizzazioni del bucket Cloud Storage (consigliato) .
• Aggiungi un vincolo di criteri a livello di organizzazione che interessa tutti i progetti all'interno dell'organizzazione.

La prima di queste tecniche è preferibile perché localizza l'ambito dell'effetto su un singolo progetto Cloud Firestore. La seconda tecnica non è preferibile perché non esegue la migrazione delle autorizzazioni dei bucket di Cloud Storage esistenti. Tuttavia, offre conformità alla sicurezza a livello di organizzazione.

Esegui la migrazione controllando e aggiornando le autorizzazioni del bucket Cloud Storage

Il processo di migrazione prevede due fasi:

1. Aggiorna le autorizzazioni del bucket Cloud Storage. Vedere la sezione seguente per i dettagli.
2. Conferma la migrazione all'agente di servizio Cloud Firestore.

Autorizzazioni del bucket dell'agente di servizio

Per qualsiasi operazione di esportazione o importazione che utilizza un bucket Cloud Storage in un altro progetto, devi concedere all'agente di servizio Cloud Firestore le autorizzazioni per quel bucket. Ad esempio, le operazioni che spostano i dati in un altro progetto devono accedere a un bucket in quell'altro progetto. In caso contrario, queste operazioni non riescono dopo la migrazione all'agente di servizio Cloud Firestore.

I flussi di lavoro di importazione ed esportazione che rimangono all'interno dello stesso progetto non richiedono modifiche alle autorizzazioni. L'agente di servizio Cloud Firestore può accedere ai bucket nello stesso progetto per impostazione predefinita.

Aggiorna le autorizzazioni per i bucket Cloud Storage da altri progetti per consentire l'accesso all'agente di servizio service- PROJECT_NUMBER @gcp-sa-firestore.iam.gserviceaccount.com . Concedi all'agente di servizio il ruolo Firestore Service Agent .

Il ruolo Firestore Service Agent concede le autorizzazioni di lettura e scrittura per un bucket Cloud Storage. Se devi concedere autorizzazioni di sola lettura o solo di scrittura, utilizza un ruolo personalizzato .

Il processo di migrazione descritto nella sezione seguente ti aiuta a identificare i bucket Cloud Storage che potrebbero richiedere aggiornamenti delle autorizzazioni.

Migrare un progetto all'agente di servizio Firestore

Completa i seguenti passaggi per eseguire la migrazione dall'account di servizio App Engine all'agente di servizio Cloud Firestore. Una volta completata, la migrazione non può essere annullata.

1. Vai alla pagina di importazione/esportazione di Cloud Firestore nella console di Google Cloud Platform.

   Vai a Importa/Esporta

2. Se il tuo progetto non è ancora migrato all'agente di servizio Cloud Firestore, vedrai un banner che descrive la migrazione e un pulsante Controlla stato bucket . Il passaggio successivo consente di identificare e correggere potenziali errori di autorizzazione.

   Fai clic su Controlla stato bucket .

   Viene visualizzato un menu con l'opzione per completare la migrazione e un elenco di bucket Cloud Storage. Il completamento del caricamento dell'elenco potrebbe richiedere alcuni minuti.

   Questo elenco include i bucket utilizzati di recente nelle operazioni di importazione ed esportazione, ma che attualmente non concedono autorizzazioni di lettura e scrittura all'agente del servizio Cloud Firestore.

3. Prendi nota del nome principale dell'agente di servizio Cloud Firestore del tuo progetto. Il nome dell'agente di servizio viene visualizzato sotto l' agente di servizio per consentire l'accesso all'etichetta .

4. Per qualsiasi bucket nell'elenco che utilizzerai per future operazioni di importazione o esportazione, completa i seguenti passaggi:

   1. Nella riga della tabella di questo bucket, fai clic su Correggi . Questo apre la pagina delle autorizzazioni del bucket in una nuova scheda.

   2. Fare clic su Aggiungi .
   3. Nel campo Nuove entità , inserisci il nome del tuo agente di servizio Cloud Firestore.
   4. Nel campo Seleziona un ruolo , seleziona Agenti di servizio > Agente di servizio Firestore .
   5. Fare clic su Salva .
   6. Torna alla scheda con la pagina di importazione/esportazione di Cloud Firestore.
   7. Ripeti questi passaggi per gli altri bucket nell'elenco. Assicurati di visualizzare tutte le pagine dell'elenco.

5. Fai clic su Migra a Firestore Service Agent . Se disponi ancora di bucket con controlli delle autorizzazioni non riusciti, devi confermare la migrazione facendo clic su Migra .

   Un avviso ti informa quando la migrazione è stata completata. La migrazione non può essere annullata.

Visualizza lo stato della migrazione

1. Per verificare lo stato della migrazione del tuo progetto, vai alla pagina Importa/Esporta nella console di Google Cloud Platform:

   Vai a Importa/Esporta

2. Cerca l'entità accanto ai processi di importazione/esportazione eseguiti come etichetta.

   Se l'entità è service- PROJECT_NUMBER @gcp-sa-firestore.iam.gserviceaccount.com , il tuo progetto è già stato migrato all'agente di servizio Cloud Firestore. La migrazione non può essere annullata.

   Se il progetto non è stato migrato, nella parte superiore della pagina viene visualizzato un banner con un pulsante Controlla stato bucket . Consulta Migrazione all'agente di servizio Firestore per completare la migrazione.

Aggiungi un vincolo di criteri a livello di organizzazione

• Imposta il seguente vincolo nella policy della tua organizzazione:

  Richiedi l'agente del servizio Firestore per l'importazione/esportazione ( firestore.requireP4SAforImportExport ).

  Questo vincolo richiede che le operazioni di importazione ed esportazione utilizzino l'agente di servizio Cloud Firestore per autorizzare le richieste. Per impostare questo vincolo, consulta Creazione e gestione dei criteri dell'organizzazione .

L'applicazione di questo vincolo del criterio organizzativo non concede automaticamente le autorizzazioni del bucket Cloud Storage appropriate per l'agente di servizio Cloud Firestore.

Se il vincolo crea errori di autorizzazione per qualsiasi flusso di lavoro di importazione o esportazione, puoi disabilitarlo per tornare a utilizzare l'account di servizio predefinito. Dopo aver controllato e aggiornato le autorizzazioni del bucket Cloud Storage , puoi abilitare nuovamente il vincolo.