データのエクスポートをスケジュールする

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 Console

Cloud 関数を作成

1. Google Cloud コンソールの [Cloud Functions] ページに移動します。

   Cloud Functions に移動

2. [関数を作成] をクリックします。
3. 関数名を入力します（例: firestoreExport）。
4. [トリガー] で [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) => {
     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 Functions の関数を呼び出す Cloud Scheduler ジョブを作成します。

1. Google Cloud コンソールの [Cloud Scheduler] ページに移動します。

   Cloud Scheduler に移動

2. [ジョブを作成] をクリックします。
3. [名前] にジョブの名前を入力します（例: scheduledFirestoreExport）。
4. [頻度] に入力します（例: every 24 hours）。
5. [タイムゾーン] でタイムゾーンを選択します。
6. [ターゲット] で [Pub/Sub] を選択します。[トピック] フィールドに、Cloud Function とともに定義した Pub/Sub トピックの名前を入力します。上記の例では、initiateFirestoreExport です。
7. [ペイロード] フィールドに「start export」と入力します。ジョブにはペイロードを定義する必要がありますが、上記の Cloud Function で実際にこの値が使用されることはありません。
8. [作成] をクリックします。

Firebase コンソール

Firebase コンソールの [Cloud Functions] ページに移動します。

関数のログに移動

GCP Console

Google Cloud コンソールの [Cloud Functions] ページに移動します。

[ログビューア] に移動