排定資料匯出作業

Firebase CLI

1. 安裝 Firebase CLI。在新的目錄中，為 Cloud Functions 初始化 CLI：

   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 替換為您的值區名稱。
   • 修改 every 24 hours 即可設定匯出時間表。請使用 AppEngine cron.yaml 語法或 Unix-Cron 格式 (* * * * *)。

   • 修改 collectionIds: []，只匯出指定的集合群組。維持原樣，即可匯出所有珍藏內容。

4. 部署排程函式：

   firebase deploy --only functions

Google Cloud 控制台

建立 Cloud 函式

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

   前往「Cloud Functions」頁面

2. 按一下「Create Function」
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 替換為您的值區名稱。

   • 修改 collectionIds: []，只匯出指定的集合群組。維持原樣，即可匯出所有珍藏內容。

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

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

8. 在「要執行的函式」下方輸入 scheduledFirestoreExport，即 index.js 中的函式名稱。
9. 按一下「建立」，即可部署 Cloud 函式。

建立 Cloud Scheduler 工作

接下來，請建立呼叫 Cloud 函式的 Cloud Scheduler 工作：

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

   前往 Cloud Scheduler

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

Firebase 主控台

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

前往「Function Logs」

GCP 控制台

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

前往「記錄檢視器」