Pianificare le esportazioni di dati

Questa pagina descrive come pianificare le esportazioni dei dati di Firestore. Per eseguire le esportazioni in base a una pianificazione, ti consigliamo di utilizzare le funzioni Cloud Run e Cloud Scheduler.

Prima di iniziare

Prima di pianificare le esportazioni dei dati gestiti, devi completare le seguenti attività:

  1. Abilita la fatturazione per il tuo progetto Google Cloud. Solo i progetti Google Cloud con la fatturazione abilitata possono utilizzare la funzionalità di esportazione e importazione.
  2. Le operazioni di esportazione richiedono un bucket Cloud Storage di destinazione. Crea un bucket Cloud Storage in una località vicino alla località del database Firestore. Non puoi utilizzare un bucket Chi paga il richiedente per le operazioni di esportazione.

Creare una Cloud Function e un job Cloud Scheduler

Segui i passaggi riportati di seguito per creare una Cloud Function Node.js che avvia un'esportazione dei dati di Firestore e un job Cloud Scheduler per chiamare la funzione:

interfaccia a riga di comando di Firebase
  1. Installa l'interfaccia a riga di comando di Firebase. In una nuova directory, inizializza l'interfaccia a riga di comando per le funzioni Cloud Run:

    firebase init functions --project PROJECT_ID
    1. Seleziona JavaScript per la lingua.
    2. Se vuoi, attiva ESLint.
    3. Inserisci y per installare le dipendenze.
  2. Sostituisci il codice nel file functions/index.js con quanto segue:

    const functions = require('firebase-functions');
    const firestore = require('@google-cloud/firestore');
    const client = new firestore.v1.FirestoreAdminClient();
    
    // Replace BUCKET_NAME
    const bucket = 'gs://BUCKET_NAME';
    
    exports.scheduledFirestoreExport = functions.pubsub
                                                .schedule('every 24 hours')
                                                .onRun((context) => {
    
      const projectId = process.env.GCP_PROJECT;
      const databaseName = 
        client.databasePath(projectId, '(default)');
    
      return client.exportDocuments({
        name: databaseName,
        outputUriPrefix: bucket,
        // Leave collectionIds empty to export all collections
        // or set to a list of collection IDs to export,
        // collectionIds: ['users', 'posts']
        collectionIds: []
        })
      .then(responses => {
        const response = responses[0];
        console.log(`Operation Name: ${response['name']}`);
      })
      .catch(err => {
        console.error(err);
        throw new Error('Export operation failed');
      });
    });
  3. Nel codice precedente, modifica quanto segue:
    • Sostituisci BUCKET_NAME con il nome del bucket.
    • Modifica every 24 hours per impostare la pianificazione dell'esportazione. Utilizza la sintassi cron.yaml di App Engine o il formato unix-cron (* * * * *).
    • Modifica collectionIds: [] per esportare solo i gruppi di raccolte specificati. Lascia invariato per esportare tutte le raccolte.

  4. Esegui il deployment della funzione pianificata:

    firebase deploy --only functions
Console Google Cloud
Crea una funzione Cloud
  1. Vai alla pagina Cloud Functions nella console Google Cloud:

    Vai a Cloud Functions

  2. Fai clic su Crea funzione
  3. Inserisci un nome funzione, ad esempio firestoreExport
  4. In Trigger, seleziona Cloud Pub/Sub.
  5. Nella sezione Argomento, seleziona Crea nuovo argomento. Inserisci un nome per l'argomento Pub/Sub, ad esempio initiateFirestoreExport. Prendi nota del nome dell'argomento, poiché lo dovrai utilizzare per creare il job Cloud Scheduler.
  6. In Codice sorgente, seleziona Editor incorporato. Inserisci il seguente codice in index.js:
    const firestore = require('@google-cloud/firestore');
    const client = new firestore.v1.FirestoreAdminClient();
    // Replace BUCKET_NAME
    const bucket = 'gs://BUCKET_NAME'
    
    exports.scheduledFirestoreExport = (event, context) => {
      const databaseName = client.databasePath(
        process.env.GCP_PROJECT,
        '(default)'
      );
    
      return client
        .exportDocuments({
          name: databaseName,
          outputUriPrefix: bucket,
          // Leave collectionIds empty to export all collections
          // or define a list of collection IDs:
          // collectionIds: ['users', 'posts']
          collectionIds: [],
        })
        .then(responses => {
          const response = responses[0];
          console.log(`Operation Name: ${response['name']}`);
          return response;
        })
        .catch(err => {
          console.error(err);
        });
    };
    Nel codice riportato sopra, modifica quanto segue:
    • Sostituisci BUCKET_NAME con il nome del bucket.
    • Modifica collectionIds: [] per esportare solo i gruppi di raccolte specificati. Lascia invariato per esportare tutte le raccolte.

  7. In package.json, aggiungi la seguente dipendenza:
    {
      "dependencies": {
        "@google-cloud/firestore": "^1.3.0"
      }
    }
  8. In Funzione da eseguire, inserisci scheduledFirestoreExport, il nome della funzione in index.js.
  9. Fai clic su Crea per eseguire il deployment della Cloud Function.
Crea un job Cloud Scheduler

A questo punto, crea un job Cloud Scheduler che chiami la tua Cloud Function:

  1. Vai alla pagina Cloud Scheduler nella console Google Cloud:

    Vai a Cloud Scheduler

  2. Fai clic su Crea job.
  3. Inserisci un Nome per il job, ad esempio scheduledFirestoreExport.
  4. Inserisci una frequenza, ad esempio every 24 hours.
  5. Seleziona un Fuso orario.
  6. In Destinazione, seleziona Pub/Sub. Nel campo Topic, inserisci il nome dell'argomento Pub/Sub che hai definito insieme alla funzione Cloud, initiateFirestoreExport nell'esempio precedente.
  7. Nel campo Payload, inserisci start export. Il job richiede un payload definito, ma la Cloud Function sopra riportata non utilizza effettivamente questo valore.
  8. Fai clic su Crea.
A questo punto, hai eseguito il deployment della Cloud Function e del job Cloud Scheduler, ma la Cloud Function ha ancora bisogno delle autorizzazioni di accesso per eseguire le operazioni di esportazione.

Configurare le autorizzazioni di accesso

Successivamente, concedi alla funzione Cloud l'autorizzazione per avviare le operazioni di esportazione e scrivere nel bucket GCS.

Questa funzione Cloud utilizza l'account di servizio predefinito del progetto per autenticare e autorizzare le operazioni di esportazione. Quando crei un progetto, viene creato un account di servizio predefinito con il seguente nome:

PROJECT_ID@appspot.gserviceaccount.com

Questo account di servizio richiede l'autorizzazione per avviare un'operazione di esportazione e scrivere nel bucket Cloud Storage. Per concedere queste autorizzazioni, assegna i seguenti ruoli IAM all'account di servizio predefinito:

  • Cloud Datastore Import Export Admin
  • Ruolo Owner o Storage Admin nel bucket

Puoi utilizzare gli strumenti a riga di comando gcloud e gsutil per assegnare questi ruoli.

Se non sono già installati, puoi accedere a questi strumenti da Cloud Shell nella console Google Cloud:
Avvia Cloud Shell

  1. Assegna il ruolo Cloud Datastore Import Export Admin. Sostituisci PROJECT_ID ed esegui il seguente comando:

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member serviceAccount:PROJECT_ID@appspot.gserviceaccount.com \
        --role roles/datastore.importExportAdmin
  2. Assegna il ruolo Amministratore archiviazione al bucket. Sostituisci PROJECT_ID e BUCKET_NAME ed esegui il seguente comando:

    gsutil iam ch serviceAccount:PROJECT_ID@appspot.gserviceaccount.com:admin \
        gs://BUCKET_NAME

Se disattivi o elimini il tuo account di servizio predefinito di App Engine, la tua app App Engine perderà l'accesso al database Firestore. Se hai disattivato il tuo account di servizio App Engine, puoi riattivarlo. consulta la sezione Attivare un account di servizio. Se hai eliminato il tuo account di servizio App Engine negli ultimi 30 giorni, puoi ripristinarlo. Consulta la sezione Annullare l'eliminazione di un account di servizio.

Testa il job Cloud Scheduler e Cloud Function

Puoi testare il job Cloud Scheduler nella pagina Cloud Scheduler della console Google Cloud.

  1. Vai alla pagina Cloud Scheduler nella console Google Cloud.
    Vai a Cloud Scheduler

  2. Nella riga del nuovo job Cloud Scheduler, fai clic su Esegui ora.

    Dopo alcuni secondi, il job Cloud Scheduler dovrebbe aggiornare la colonna dei risultati su Successo e Ultima esecuzione sull'ora corrente. Potrebbe essere necessario fare clic su Aggiorna.

La pagina Cloud Scheduler conferma solo che il job ha chiamato la Cloud Function. Apri la pagina della funzione Cloud per visualizzare i relativi log.

Visualizza i log di Cloud Function

Per verificare se la Cloud Function ha avviato correttamente un'operazione di esportazione, apri i log della funzione:

Console Firebase

Vai alla pagina Funzioni Cloud Run nella Console Firebase.

Vai a Log delle funzioni

Console di GCP

Vai alla pagina Funzioni Cloud Run nella console Google Cloud.

Vai al visualizzatore log

Visualizzare l'avanzamento dell'esportazione

Puoi utilizzare il comando gcloud firestore operations list per visualizzare lo stato di avanzamento delle operazioni di esportazione. Consulta la sezione Gestire le operazioni di esportazione e importazione.

Al termine di un'operazione di esportazione, puoi visualizzare i file di output nel tuo bucket Cloud Storage:

Apri il browser Cloud Storage