排定資料匯出作業

Firebase CLI

1. 安裝 Firebase CLI。 在新目錄中，初始化 CLI 以進行 Cloud Functions：

   firebase init functions --project PROJECT_ID

   1. 選取「JavaScript」做為語言。
   2. 選擇是否啟用 ESLint。
   3. 輸入 y 安裝依附元件。

2. 將 functions/index.js 檔案中的程式碼替換成以下程式碼：

   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. 在上述程式碼中，修改下列項目：
   • 將 BUCKET_NAME 替換為您的 bucket 名稱。
   • 修改 every 24 hours 即可設定匯出時間表。使用 App Engine cron.yaml 語法或 unix-cron 格式 (* * * * *)。

   • 修改 collectionIds: []，只匯出指定的集合群組。如要匯出所有集合，請維持原狀。

4. 部署排定時間執行的函式：

   firebase deploy --only functions

Google Cloud 控制台

建立 Cloud 函式

1. 前往 Google Cloud 控制台的「Cloud Functions」頁面：

   前往「Cloud Functions」頁面

2. 按一下「建立函式」
3. 輸入函式名稱，例如 firestoreExport
4. 在「Trigger」(觸發條件)下方，選取「Cloud Pub/Sub」
5. 在「主題」下方，選取「建立新主題」。輸入 Pub/Sub 主題的名稱，例如 initiateFirestoreExport。請記下主題名稱，因為您需要這個名稱才能建立 Cloud Scheduler 工作。
6. 在「Source code」(原始碼) 下，選取「Inline editor」(內嵌編輯器)。在 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);
       });
   };

   在上述程式碼中，修改下列項目：
   • 將 BUCKET_NAME 替換為您的 bucket 名稱。

   • 修改 collectionIds: []，只匯出指定的集合群組。如要匯出所有集合，請維持原狀。

7. 在 package.json 下方新增下列依附元件：

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

8. 在「Function to execute」(要執行的函式) 底下，輸入 scheduledFirestoreExport，也就是 index.js 中的函式名稱。
9. 按一下「建立」，部署 Cloud 函式。

建立 Cloud Scheduler 工作

接著，建立呼叫 Cloud Function 的 Cloud Scheduler 工作：

1. 前往 Google Cloud 控制台的「Cloud Scheduler」頁面：

   前往 Cloud Scheduler

2. 按一下 [Create Job] (建立工作)。
3. 輸入工作「名稱」，例如 scheduledFirestoreExport。
4. 輸入「頻率」，例如 every 24 hours。
5. 選取「時區」。
6. 在「目標」下方，選取「Pub/Sub」。在「Topic」(主題) 欄位中，輸入您在 Cloud Function 旁定義的 Pub/Sub 主題名稱，如上例中的 initiateFirestoreExport。
7. 在「Payload」(酬載) 欄位中輸入 start export。 這項作業需要定義酬載，但上述 Cloud 函式實際上並未使用這個值。
8. 點選「建立」。

Firebase 主控台

前往 Firebase 控制台的「Cloud Functions」頁面。

前往函式記錄

GCP 控制台

前往 Google Cloud 控制台的「Cloud Functions」頁面。

前往記錄檢視器