排定資料匯出作業

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 替換為 bucket 名稱。
   • 將 YOUR_PROJECT_ID 替換為您的專案 ID
   • 修改 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. 按一下「編寫函式」
3. 輸入函式名稱，例如 firestore-export
4. 在「Trigger」(觸發條件) 下方，選取「Cloud Pub/Sub」。
5. 在「主題」下方，選取「建立新主題」。輸入 Pub/Sub 主題的名稱，例如 initiateFirestoreExport。請記下主題名稱，因為建立 Cloud Scheduler 工作時會用到。
6. 在「原始碼」下方，選取「內嵌編輯器」。在 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);
       });
   };

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

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

   • (選用) 如果您使用的是非預設資料庫，請務必在建立 Cloud 函式時設定 DATABASE_ID 環境變數。如果您使用的執行階段不會自動設定 GOOGLE_CLOUD_PROJECT，可能也需要手動設定，或在程式碼中替換成專案 ID。

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

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

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

建立 Cloud Scheduler 工作

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

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

   前往「Cloud Scheduler」

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