Pianificare le esportazioni di dati

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 Cloud Functions:

   firebase init functions --project PROJECT_ID

   1. Seleziona JavaScript come linguaggio.
   2. Facoltativamente, attiva ESLint.
   3. Inserisci y per installare le dipendenze.

2. Sostituisci il codice nel file functions/index.js con il seguente:

   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');
     });
   });
   index.js

3. Nel codice precedente, modifica quanto segue:
   • Sostituisci BUCKET_NAME con il nome del tuo bucket.
   • Sostituisci YOUR_PROJECT_ID con l'ID progetto.
   • 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 tutti i gruppi di raccolte.

4. Esegui il deployment della funzione pianificata:

   firebase deploy --only functions

Console Google Cloud

Crea una funzione Cloud Functions

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

   Vai a Cloud Functions

2. Fai clic su Scrivi una funzione.
3. Inserisci un nome per la funzione, ad esempio firestore-export
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, perché ti servirà 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) => {
     // Access the GCLOUD_PROJECT environment variable set by the runtime.
     const projectId =
       process.env.GOOGLE_CLOUD_PROJECT || process.env.GCLOUD_PROJECT;
     // Use the DATABASE_ID environment variable if set,
     // otherwise default to '(default)'
     const databaseId = process.env.DATABASE_ID || '(default)';
     const databaseName = client.databasePath(
       projectId,
       databaseId
     );
   
     return client
       .exportDocuments({
         name: databaseName,
         outputUriPrefix: bucket,
         // Leave collectionIds empty to export all collection groups
         // or define a list of collection group 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 precedente, modifica quanto segue:
   • Sostituisci BUCKET_NAME con il nome del tuo bucket.

   • Modifica collectionIds: [] per esportare solo i gruppi di raccolte specificati. Lascia invariato per esportare tutti i gruppi di raccolte.

   • (Facoltativo) Se utilizzi un database non predefinito, assicurati di impostare la variabile di ambiente DATABASE_ID durante la creazione della funzione Cloud Functions. Se utilizzi un runtime in cui GOOGLE_CLOUD_PROJECT non viene impostato automaticamente, potresti anche doverlo impostare manualmente o sostituirlo con l'ID progetto nel codice.

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 funzione Cloud Functions.

Crea un job Cloud Scheduler

A questo punto, crea un job Cloud Scheduler che chiama la tua funzione Cloud Functions:

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 Target, seleziona Pub/Sub. Nel campo Argomento, inserisci il nome dell'argomento Pub/Sub definito insieme alla funzione Cloud Functions, initiateFirestoreExport nell'esempio precedente.
7. Nel campo Payload, inserisci start export. Il job richiede la definizione di un payload, ma la funzione Cloud Functions precedente non utilizza effettivamente questo valore.
8. Fai clic su Crea.