Как настроить экспорт данных по расписанию

интерфейс командной строки Firebase

1. Установите интерфейс командной строки Firebase. В новом каталоге инициализируйте 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 названием своего сегмента.
   • Замените YOUR_PROJECT_ID идентификатором своего проекта.
   • Измените every 24 hours, чтобы задать расписание экспорта. Используйте синтаксис AppEngine cron.yaml или формат unix-cron (* * * * *).

   • Измените collectionIds: [], чтобы экспортировать только указанные группы коллекций. Если вы хотите экспортировать все группы коллекций, оставьте поле пустым.

4. Разверните запланированную функцию:

   firebase deploy --only functions

Консоль Google Cloud

Создать функцию в Cloud Functions

1. В консоли Google Cloud перейдите на страницу Cloud Functions.

   Перейти к Cloud Functions

2. Нажмите Написать функцию.
3. Введите название функции, например firestore-export.
4. В разделе Триггер выберите Cloud Pub/Sub.
5. В разделе Тема выберите Создать тему. Введите название темы издатель-подписчик, например 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 названием своего сегмента.

   • Измените collectionIds: [], чтобы экспортировать только указанные группы коллекций. Если вы хотите экспортировать все группы коллекций, оставьте это поле пустым.

   • Если вы используете базу данных, отличную от базы данных по умолчанию, при создании функции Cloud Functions задайте переменную среды DATABASE_ID. Если вы используете среду выполнения, в которой GOOGLE_CLOUD_PROJECT не задается автоматически, вам может потребоваться задать ее вручную или заменить идентификатором проекта в коде.

7. В разделе package.json добавьте следующую зависимость:

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

8. В поле Выберите функцию для запуска введите scheduledFirestoreExport – название функции в index.js.
9. Нажмите Create (Создать), чтобы развернуть функцию Cloud Functions.

Создать задание Cloud Scheduler

Затем создайте задание Cloud Scheduler, которое вызывает функцию Cloud Functions:

1. Перейдите на страницу Cloud Scheduler в консоли Google Cloud.

   Перейти: Cloud Scheduler

2. Нажмите Create Job (Создать задание).
3. Введите название задания, например scheduledFirestoreExport.
4. Укажите частоту, например every 24 hours.
5. Выберите часовой пояс.
6. В разделе Target (Цель) выберите Pub/Sub. В поле Тема введите название темы издателя-подписчика, которую вы определили вместе с функцией Cloud Functions (в примере выше это initiateFirestoreExport).
7. В поле Полезная нагрузка введите start export. Для задания требуется определить полезную нагрузку, но предыдущая функция Cloud Functions не использует это значение.
8. Нажмите Создать.