Planifier les exportations de données

CLI Firebase

1. Installez la CLI Firebase. Dans un nouveau répertoire, initialisez la CLI pour les fonctions Cloud Run:

   firebase init functions --project PROJECT_ID

   1. Sélectionnez le langage JavaScript.
   2. Vous pouvez également activer ESLint.
   3. Saisissez y pour installer les dépendances.

2. Remplacez le code du fichier functions/index.js par le code suivant :

   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. Dans le code ci-dessus, modifiez les éléments suivants :
   • Remplacez BUCKET_NAME par le nom de votre bucket.
   • Modifiez every 24 hours pour définir votre calendrier d'exportation. Utilisez la syntaxe AppEngine cron.yaml ou le format unix-cron (* * * * *).

   • Modifiez collectionIds: [] pour n'exporter que les groupes de collections spécifiés. Laissez tel quel pour exporter toutes les collections.

4. Déployez la fonction planifiée :

   firebase deploy --only functions

Console Google Cloud

Créer une fonction Cloud

1. Accédez à la page Cloud Functions dans la console Google Cloud:

   Accéder à Cloud Functions

2. Cliquez sur Créer une fonction
3. Saisissez un nom de fonction tel que firestoreExport
4. Sous Déclencheur, sélectionnez Cloud Pub/Sub
5. Sous Sujet, sélectionnez Créer un sujet. Saisissez un nom pour le sujet Pub/Sub, par exemple initiateFirestoreExport. Notez le nom du sujet car vous en aurez besoin pour créer votre tâche Cloud Scheduler.
6. Sous Code source, sélectionnez Éditeur intégré. Saisissez le code suivant sous 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);
       });
   };

   Dans le code ci-dessus, modifiez les éléments suivants :
   • Remplacez BUCKET_NAME par le nom de votre bucket.

   • Modifiez collectionIds: [] pour n'exporter que les groupes de collections spécifiés. Laissez tel quel pour exporter toutes les collections.

7. Sous package.json, ajoutez la dépendance suivante :

   {
     "dependencies": {
       "@google-cloud/firestore": "^1.3.0"
     }
   }

8. Sous Fonction à exécuter, saisissez scheduledFirestoreExport, le nom de la fonction dans index.js.
9. Cliquez sur Créer pour déployer la fonction Cloud.

Créer une tâche Cloud Scheduler

Ensuite, créez une tâche Cloud Scheduler qui appelle votre fonction Cloud :

1. Accédez à la page Cloud Scheduler dans la console Google Cloud:

   Accéder à Cloud Scheduler

2. Cliquez sur Créer une tâche.
3. Saisissez un Nom pour la tâche, par exemple scheduledFirestoreExport.
4. Saisissez une Fréquence, par exemple, every 24 hours.
5. Sélectionnez un Fuseau horaire.
6. Sous Cible, sélectionnez Pub/Sub. Dans le champ Sujet, saisissez le nom du sujet Pub/Sub que vous avez défini à côté de votre fonction Cloud, initiateFirestoreExport dans l'exemple ci-dessus.
7. Dans le champ Charge utile, saisissez start export. La tâche demande de définir une charge utile, mais la fonction Cloud ci-dessus n'utilise pas cette valeur en réalité.
8. Cliquez sur Créer.

Console Firebase

Accédez à la page Cloud Run Functions (Fonctions Cloud Run) dans la console Firebase.

Accéder aux journaux de la fonction

Console GCP

Accédez à la page Fonctions Cloud Run dans la console Google Cloud.

Accéder à la visionneuse de journaux