Schedule data exports

Firebase CLI

1. Install the Firebase CLI. In a new directory, initialize the CLI for Cloud Functions:

   firebase init functions --project PROJECT_ID

   1. Select JavaScript for the language.
   2. Optionally, enable ESLint.
   3. Enter y to install dependencies.

2. Replace the code in the functions/index.js file with the following:

   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 || process.env.GCLOUD_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']}`);
       return response;
     })
     .catch(err => {
       console.error(err);
       throw new Error('Export operation failed');
     });
   });
   index.js
   

3. In the code above, modify the following:
   • Replace BUCKET_NAME with the name of your bucket.
   • Modify every 24 hours to set your export schedule. Use either AppEngine cron.yaml syntax or the unix-cron format (* * * * *).

   • Modify collectionIds: [] to export only the specified collection groups. Leave as is to export all collections.

4. Deploy the scheduled function:

   firebase deploy --only functions

GCP Console

Create a Cloud Function

1. Open the Cloud Functions page in the GCP Console:

   Open the Cloud Functions page

2. Click Create Function
3. Enter a function name such as firestoreExport
4. Under Trigger, select Cloud Pub/Sub
5. Under Topic, select Create new Topic. Enter a name for the pub/sub topic, such as initiateFirestoreExport. Take note of the topic name as you need it to create your Cloud Scheduler job.
6. Under Source code, select Inline editor. Enter the following code under 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.GCLOUD_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);
       });
   };

   In the code above, modify the following:
   • Replace BUCKET_NAME with the name of your bucket.

   • Modify collectionIds: [] to export only the specified collection groups. Leave as is to export all collections.

7. Under package.json, add the following dependency:

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

8. Under Function to execute, enter scheduledFirestoreExport, the name of the function in index.js.
9. Click Create to deploy the Cloud Function.

Create a Cloud Scheduler job

Next, create a Cloud Scheduler job that calls your Cloud Function:

1. Open the Cloud Scheduler page in the GCP Console:

   Open the Cloud Scheduler page

2. Click Create Job.
3. Enter a Name for the job such as scheduledFirestoreExport.
4. Enter a Frequency, for example, every 24 hours.
5. Select a Timezone.
6. Under Target, select Pub/Sub. In the Topic field, enter the name of the pub/sub topic you defined alongside your Cloud Function, initiateFirestoreExport in the example above.
7. In the Payload field, enter start export. The job requires a payload defined, but the Cloud Function above does not actually use this value.
8. Click Create.

Firebase Console

Open the Cloud Functions page in the Firebase console.

Open the Function Logs page

GCP Console

Open the Cloud Functions page in the GCP Console.

Open the Logs Viewer page