Esportazione e importazione di dati

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

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

Prima di iniziare

Prima di poter utilizzare il servizio di esportazione e importazione gestito, devi 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 località vicina alla località del tuo database Firestore. Non puoi utilizzare un bucket con Pagamenti del richiedente o un bucket rapido per le operazioni di esportazione e importazione.
  3. Assicurati che il tuo account disponga delle autorizzazioni necessarie per Firestore e Cloud Storage. Se sei il Project Owner, 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 Firestore: Owner, Cloud Datastore Owner o Cloud Datastore Import Export Admin
    • Ruoli di Cloud Storage: Owner o Storage Admin

Autorizzazioni agente di servizio

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

Service agent Firestore
service-PROJECT_NUMBER@gcp-sa-firestore.iam.gserviceaccount.com

Per saperne di più sugli agenti di servizio, consulta Agenti di servizio.

L'agente di servizio 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 Firestore, l'agente di servizio 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 Firestore l'accesso al bucket Cloud Storage.

Assegna i ruoli all'agente di servizio

Puoi utilizzare lo strumento a riga di comando gsutil per assegnare uno dei ruoli riportati di seguito. Ad esempio, per assegnare il ruolo Amministratore Storage all'agente di servizio Firestore, esegui questo comando:

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 progetto, che viene utilizzato per assegnare un nome all'agente di servizio Firestore. Per visualizzare il nome dell'agente di servizio, consulta Visualizza il nome dell'agente di servizio.

In alternativa, puoi assegnare questo ruolo utilizzando la console Google Cloud .

Visualizza il nome dell'agente di servizio

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

  1. Nella console Google Cloud , vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Importa/Esporta.

  4. Visualizza l'account di autorizzazione accanto all'etichetta Esegui job di importazione/esportazione come.

L'agente di servizio deve disporre 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 Google Cloud 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:

Esporta i dati

Un'operazione di esportazione copia i documenti del database in un insieme di file in un bucket Cloud Storage. Tieni presente che un'esportazione non è uno snapshot esatto del database acquisito all'ora di inizio dell'esportazione. Un'esportazione può includere le modifiche apportate durante l'esecuzione dell'operazione.

Esportazione di tutti i documenti

Google Cloud Console

  1. Nella console Google Cloud , vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Importa/Esporta.

  4. Fai clic su Esporta.

  5. Fai clic sull'opzione Esporta intero database.

  6. In Scegli destinazione, inserisci il nome di un bucket Cloud Storage o utilizza il pulsante Sfoglia per selezionare un bucket.

  7. Fai clic su Esporta.

La console torna alla pagina Importa/Esporta. Se l'operazione viene avviata correttamente, la pagina aggiunge una voce alla pagina delle importazioni ed esportazioni recenti. In caso di errore, la pagina visualizza un messaggio di errore.

gcloud

Utilizza il comando firestore export per esportare tutti i documenti nel database, sostituendo [BUCKET_NAME] con il nome del tuo bucket Cloud Storage. Aggiungi il flag --async per impedire allo strumento gcloud di attendere il completamento dell'operazione.

  gcloud firestore export gs://[BUCKET_NAME] \
  --database=[DATABASE]

Sostituisci quanto segue:

  • BUCKET_NAME: organizza le esportazioni aggiungendo un prefisso al file dopo il nome del bucket, ad esempio BUCKET_NAME/my-exports-folder/export-name. Se non fornisci un prefisso del file, il servizio di esportazione gestita ne crea uno in base al timestamp corrente.

  • DATABASE: il nome del database da cui vuoi esportare i documenti. Per il database predefinito, utilizza --database='(default)'.

Una volta avviata un'operazione di esportazione, la chiusura del terminale non annulla l'operazione. Consulta Annulla un'operazione.

Esporta gruppi di raccolte specifici

Google Cloud Console

  1. Nella console Google Cloud , vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Importa/Esporta.

  4. Fai clic su Esporta.

  5. Fai clic sull'opzione Esporta uno o più gruppi di raccolte. Utilizza il menu per selezionare uno o più gruppi di raccolte.

  6. In Scegli destinazione, inserisci il nome di un bucket Cloud Storage o utilizza il pulsante Sfoglia per selezionare un bucket.

  7. Fai clic su Esporta.

La console torna alla pagina Importa/Esporta. Se l'operazione viene avviata correttamente, la pagina aggiunge una voce alla pagina delle importazioni ed esportazioni recenti. In caso di errore, la pagina visualizza un messaggio di errore.

gcloud

Per esportare gruppi di raccolte specifici, utilizza il flag --collection-ids. L'operazione esporta solo i gruppi di raccolte con gli ID specificati. Un gruppo di raccolte include tutte le raccolte e le sottoraccolte il cui ID raccolta finale è l'ID gruppo di raccolte.

gcloud firestore export gs://[BUCKET_NAME] \
--collection-ids=[COLLECTION_GROUP_ID_1],[COLLECTION_GROUP_ID_2] \
--database=[DATABASE]

Ad esempio, puoi progettare una raccolta restaurants nel database foo in modo che includa più sottoraccolte, come ratings, reviews o outlets. Per esportare il gruppo di raccolte reviews, deve essere elencato esplicitamente:

gcloud firestore export gs://[BUCKET_NAME] \
--collection-ids=reviews \
--database='cymbal'

Se invece viene specificato restaurants, i documenti nella raccolta secondaria reviews non verranno esportati.

Esporta da un timestamp PITR

Puoi esportare il database in Cloud Storage dai dati PITR. Puoi esportare i dati PITR in cui il timestamp è un timestamp di un minuto intero compreso negli ultimi sette giorni, ma non prima del giorno earliestVersionTime. Se i dati non esistono più nel timestamp specificato, l'operazione di esportazione non va a buon fine.

L'operazione di esportazione PITR supporta tutti i filtri, inclusa l'esportazione di tutti i documenti e di gruppi di raccolte specifici.

Tieni presente quanto segue prima di esportare i dati PITR:

  • Abilita il PITR nel tuo database. Se il PITR è disabilitato, l'esportazione in un timestamp dello snapshot non va a buon fine, anche per i timestamp nell'ora precedente dopo earliestVersionTime. L'operazione di esportazione restituisce l'errore Point-in-Time Recovery must be enabled in order to execute exports at a snapshot timestamp.
  • Specifica il timestamp nel formato RFC 3339. Ad esempio, 2023-05-26T10:20:00.00Z.
  • Assicurati che il timestamp specificato sia un timestamp di un minuto intero negli ultimi sette giorni, ma non prima del earliestVersionTime. Se i dati non esistono più nel timestamp specificato, viene generato un errore.
  • Non ti verrà addebitato alcun costo per un'esportazione PITR non riuscita.

Console

  1. Nella console Google Cloud , vai alla pagina Database.

    Vai a Database
  2. Seleziona un database dall'elenco dei database.
  3. Nel menu di navigazione, fai clic su Importa/Esporta.
  4. Fai clic su Esporta.
  5. Configura l'origine dell'esportazione in modo da esportare l'intero database o solo gruppi di raccolte specifici.
  6. Nella sezione Scegli lo stato del database da esportare, seleziona Esporta da un momento precedente.

    Seleziona un'ora dello snapshot da utilizzare per l'esportazione

  7. Nella sezione Destinazione, inserisci il nome di un bucket Cloud Storage o utilizza il pulsante Sfoglia per selezionare un bucket.
  8. Fai clic su Esporta.

    La console torna alla pagina Importa/Esporta. Se l'operazione viene avviata correttamente, la pagina aggiunge una voce alla pagina delle importazioni e delle esportazioni recenti. In caso di errore, la pagina mostra un messaggio di errore.

gcloud

Puoi esportare il database in Cloud Storage dai dati PITR utilizzando il comando gcloud firestore export.

Esporta il database, specificando il parametro snapshot-time su un timestamp di recupero. Esegui il seguente comando per esportare il database nel tuo bucket.

gcloud firestore export gs://[BUCKET_NAME_PATH] \
    --snapshot-time=[PITR_TIMESTAMP]

Dove PITR_TIMESTAMP è un timestamp PITR con granularità al minuto, ad esempio 2023-05-26T10:20:00.00Z.

Aggiungi il flag --collection-ids per esportare gruppi di raccolte specifici.

Importa dati

Una volta esportati i file in Cloud Storage, puoi importare i documenti di questi file nel tuo progetto o in un altro progetto. Tieni presente quanto segue sulle operazioni di importazione:

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

  • 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 viene 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 database dopo l'importazione.

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

  • Non devi aggiungere nuovi documenti Firestore che non erano presenti nei file di output originali di un'esportazione o rimuovere documenti esistenti dai file GCS prima dell'importazione. In caso contrario, l'importazione non andrà a buon fine.

  • Il nome 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 invariati i nomi file PARENT_FOLDER_NAME e .overall_export_metadata.

Importa tutti i documenti da un'esportazione

Google Cloud Console

  1. Nella console Google Cloud , vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Importa/Esporta.

  4. Fai clic su Importa.

  5. Nel campo Nome file, inserisci il nome di un file .overall_export_metadata di un'operazione di esportazione completata. Puoi utilizzare il pulsante Sfoglia per selezionare il file.

  6. Fai clic su Importa.

La console torna alla pagina Importa/Esporta. Se l'operazione viene avviata correttamente, la pagina aggiunge una voce alla pagina delle importazioni ed esportazioni recenti. In caso di errore, la pagina visualizza un messaggio di errore.

gcloud

Utilizza il comando firestore import per importare i documenti da un'operazione di esportazione precedente.

gcloud firestore import gs://[BUCKET_NAME]/[EXPORT_PREFIX]/ --database=[DATABASE]

Sostituisci quanto segue:

  • BUCKET_NAME/EXPORT_PREFIX: la posizione dei file di esportazione.

  • DATABASE: il nome del database. Per il database predefinito, utilizza --database='(default)'.

Ad esempio:

gcloud firestore import gs://my-bucket/2017-05-25T23:54:39_76544/ --database='cymbal'

Puoi confermare la posizione dei file di esportazione nel browser Cloud Storage nella console Google Cloud :

Apri il browser Cloud Storage

Una volta avviata un'operazione di importazione, la chiusura del terminale non annulla l'operazione. Consulta Annulla un'operazione.

Importa gruppi di raccolte specifici

Google Cloud Console

Non puoi selezionare gruppi di raccolte specifici nella console. Utilizza invece gcloud.

gcloud

Per importare gruppi di raccolte specifici da un insieme di file di esportazione, utilizza il flag --collection-ids. L'operazione importa solo i gruppi di raccolte con gli ID specificati. Un gruppo di raccolte include tutte le raccolte e le sottoraccolte il cui ID raccolta finale è l'ID gruppo di raccolte. Specifica il nome del database utilizzando il flag --database. Per il database predefinito, utilizza --database='(default)'.

Solo un'esportazione di gruppi di raccolte specifici supporta un'importazione di gruppi di raccolte specifici. Non puoi importare gruppi di raccolte specifici da un'esportazione di tutti i documenti.

  gcloud firestore import gs://[BUCKET_NAME]/[EXPORT_PREFIX]/ \
  --collection-ids=[COLLECTION_GROUP_ID_1],[COLLECTION_GROUP_ID_2] \
  --database=[DATABASE]

Importa un'esportazione PITR

Segui i passaggi descritti in Importa tutti i documenti per importare il database esportato. Se un documento esiste già nel database, verrà sovrascritto.

Gestione delle operazioni di esportazione e importazione

Dopo aver avviato un'operazione di esportazione o importazione, Firestore assegna all'operazione un nome univoco. Puoi utilizzare il nome dell'operazione per eliminarla, annullarla o verificarne lo stato.

I nomi delle operazioni sono preceduti dal prefisso 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 comandi describe, cancel e delete.

Elenca tutte le operazioni di esportazione e importazione

Google Cloud Console

Puoi visualizzare un elenco delle operazioni di esportazione e importazione recenti nella pagina Importa/Esporta della console Google Cloud .

  1. Nella console Google Cloud , vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Importa/Esporta.

gcloud

Utilizza il comando operations list per visualizzare tutte le operazioni di esportazione e importazione in esecuzione e completate di recente:

gcloud firestore operations list

Controlla lo stato dell'operazione

Google Cloud Console

Puoi visualizzare lo stato di un'operazione di esportazione o importazione recente nella pagina Importa/Esporta della console Google Cloud .

  1. Nella console Google Cloud , vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Importa/Esporta.

gcloud

Utilizza il comando operations describe per visualizzare lo stato di un'operazione di esportazione o importazione.

gcloud firestore operations describe [OPERATION_NAME]

Stima il tempo di completamento

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

  • workEstimated mostra il numero totale stimato di byte e documenti che un'operazione elaborerà. Firestore potrebbe omettere questa metrica se non può 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 effettivamente elaborati, che potrebbe essere maggiore del valore di workEstimated.

Dividi workCompleted per workEstimated per una stima approssimativa dell'avanzamento. Questa stima potrebbe non essere precisa, perché dipende dalla raccolta ritardata delle statistiche.

Annulla un'operazione

Google Cloud Console

Puoi annullare un'operazione di esportazione o importazione in esecuzione nella pagina Importa/Esporta della console Google Cloud .

  1. Nella console Google Cloud , vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Importa/Esporta. Nella tabella Importazioni ed esportazioni recenti, le operazioni attualmente in esecuzione includono un pulsante Annulla nella colonna Completata. Fai clic sul pulsante Annulla per interrompere l'operazione. Il pulsante cambia in un messaggio Annullamento in corso… e poi in Annullato quando l'operazione si interrompe completamente.

Tabella delle importazioni e delle esportazioni recenti nella console che mostra un'importazione di dati in corso con un'opzione Annulla per interrompere l'operazione.

gcloud

Utilizza il comando operations cancel per interrompere un'operazione in corso:

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, mentre un'operazione di importazione annullata lascerà invariati gli aggiornamenti già apportati al database. Non puoi importare un'esportazione completata parzialmente.

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 attivare la fatturazione per il tuo progetto Google Cloud prima di utilizzare il servizio di esportazione e importazione gestite.

Le operazioni di esportazione e importazione vengono addebitate per le letture e le scritture dei documenti alle tariffe elencate in Prezzi di Firestore. Le operazioni di esportazione comportano un'operazione di lettura per ogni documento esportato. Le operazioni di importazione comportano un'operazione di scrittura per ogni documento importato.

I file di output archiviati in Cloud Storage vengono conteggiati ai fini dei costi di archiviazione dei dati di Cloud Storage.

Le operazioni di esportazione o importazione non attiveranno gli avvisi relativi al Google Cloud budget di fino al completamento. Le operazioni di esportazione e importazione non influiscono 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 sulla fatturazione Cloud, puoi utilizzare questa etichetta per visualizzare i costi relativi alle operazioni di importazione ed esportazione:

Accedi all'etichetta goog-firestoremanaged dal menu dei filtri.

Esporta in BigQuery

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

Limite di colonne BigQuery

BigQuery impone un limite di 10.000 colonne per tabella. Le operazioni di esportazione di Firestore generano uno schema di tabella BigQuery per ogni gruppo di raccolte. In questo schema, ogni nome di campo univoco all'interno di un gruppo di raccolte diventa una colonna dello schema. Se lo schema BigQuery di un gruppo di raccolte supera le 10.000 colonne, l'operazione di esportazione di Firestore tenta di rimanere al di sotto del limite di colonne trattando i campi 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 campi secondari all'interno dei campi mappa. Se il numero di colonne supera ancora 10.000, l'operazione di esportazione non genera uno schema BigQuery per il gruppo di raccolte e non puoi caricare i relativi dati in BigQuery.

Formato di esportazione e file di metadati

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

File di metadati

Un'operazione di esportazione crea un file di metadati per ogni gruppo di raccolte 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 degli agenti di servizio

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

Service agent Firestore
service-PROJECT_NUMBER@gcp-sa-firestore.iam.gserviceaccount.com

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

Service account App Engine
PROJECT_ID@appspot.gserviceaccount.com

L'agente di servizio Firestore è preferibile perché è specifico per Firestore. Il account di servizio App Engine è condiviso da più servizi.

Visualizza l'account di autorizzazione

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

  1. Nella console Google Cloud , vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.
  3. Nel menu di navigazione, fai clic su Importa/Esporta.

  4. Visualizza l'account di autorizzazione accanto all'etichetta Esegui job di importazione/esportazione come.

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

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

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

Il processo di migrazione prevede due passaggi:

  1. Aggiorna le autorizzazioni del bucket Cloud Storage. Per maggiori dettagli, consulta la sezione seguente.
  2. Conferma la migrazione all'agente di servizio 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 le autorizzazioni dell'agente di servizio Firestore per quel bucket. Ad esempio, le operazioni che spostano i dati in un altro progetto devono accedere a un bucket in quel progetto. In caso contrario, queste operazioni non riusciranno dopo la migrazione all'agente di servizio Firestore.

I workflow di importazione ed esportazione che rimangono all'interno dello stesso progetto non richiedono modifiche alle autorizzazioni. Per impostazione predefinita, l'agente di servizio Firestore può accedere ai bucket nello stesso progetto.

Aggiorna le autorizzazioni per i bucket Cloud Storage di altri progetti per concedere l'accesso al service agent 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 autorizzazioni di lettura e scrittura per un bucket Cloud Storage. Se devi concedere solo autorizzazioni di 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.

Esegui la migrazione di un progetto all'agente di servizio Firestore

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

  1. Nella console Google Cloud , vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.
  3. Nel menu di navigazione, fai clic su Importa/Esporta.

  4. Se non è ancora stata eseguita la migrazione del progetto all'agente di servizio Firestore, viene visualizzato un banner che descrive la migrazione e un pulsante Controlla stato bucket. Il passaggio successivo ti aiuta a identificare e correggere potenziali errori di autorizzazione.

    Fai clic su Controlla lo stato del bucket.

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

    Questo elenco include i bucket che sono stati utilizzati di recente nelle operazioni di importazione ed esportazione, ma che al momento non concedono autorizzazioni di lettura e autorizzazioni in scrittura all'agente di servizio Firestore.

  5. Prendi nota del nome dell'entità dell'agente di servizio Firestore del tuo progetto. Il nome dell'agente di servizio viene visualizzato sotto l'etichetta Agente di servizio a cui concedere l'accesso.
  6. 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. Si apre la pagina delle autorizzazioni del bucket in una nuova scheda.

    2. Fai clic su Aggiungi.
    3. Nel campo Nuove entità, inserisci il nome dell'agente di servizio Firestore.
    4. Nel campo Seleziona un ruolo, seleziona Agenti di servizio > Agente di servizio Firestore.
    5. Fai clic su Salva.
    6. Torna alla scheda con la pagina Importa/Esporta di Firestore.
    7. Ripeti questi passaggi per gli altri bucket nell'elenco. Assicurati di visualizzare tutte le pagine dell'elenco.
  7. Fai clic su Esegui la migrazione all'agente di servizio Firestore. Se hai ancora bucket con controlli delle autorizzazioni non riusciti, devi confermare la migrazione facendo clic su Esegui migrazione.

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

Visualizza lo stato della migrazione

Per verificare lo stato della migrazione del progetto:

  1. Nella console Google Cloud , vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.
  3. Nel menu di navigazione, fai clic su Importa/Esporta.

  4. Cerca l'entità accanto all'etichetta Job di importazione/esportazione eseguiti come.

    Se l'entità è service-PROJECT_NUMBER@gcp-sa-firestore.iam.gserviceaccount.com, la migrazione del progetto all'agente di servizio Firestore è già stata eseguita. La migrazione non può essere annullata.

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

Aggiungi un vincolo delle policy a livello di organizzazione

  • Imposta il seguente vincolo nella policy della tua organizzazione:

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

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

L'applicazione di questo vincolo della policy dell'organizzazione non concede automaticamente le autorizzazioni appropriate per i bucket Cloud Storage all'agente di servizio Firestore.

Se il vincolo genera errori di autorizzazione per i workflow di importazione o esportazione, puoi disattivarlo per tornare a utilizzare il account di servizio predefinito. Dopo aver controllato e aggiornato le autorizzazioni dei bucket Cloud Storage, puoi riattivare il vincolo.