תזמון של ייצוא נתונים

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 הוא שם הקטגוריה.
   • מחליפים את YOUR_PROJECT_ID במזהה הפרויקט.
   • משנים את every 24 hours כדי להגדיר את לוח הזמנים של הייצוא. משתמשים ב תחביר cron.yaml של AppEngine או ב פורמט unix-cron ‏ (* * * * *).

   • משנים את collectionIds: [] כדי לייצא רק את קבוצות האוספים שצוינו. כדי לייצא את כל קבוצות האוספים, משאירים את השדה כמו שהוא.

4. פורסים את הפונקציה המתוזמנת:

   firebase deploy --only functions

מסוף Google Cloud

יצירת פונקציה של Cloud Functions

1. נכנסים לדף Cloud Functions במסוף Google Cloud:

   כניסה לדף Cloud Functions

2. לוחצים על כתיבת פונקציה.
3. מזינים שם לפונקציה, למשל firestore-export
4. בקטע Trigger, בוחרים באפשרות Cloud Pub/Sub.
5. בקטע נושא, בוחרים באפשרות יצירת נושא חדש. מזינים שם לנושא Pub/Sub, למשל initiateFirestoreExport. שימו לב לשם הנושא, כי תצטרכו אותו כדי ליצור את משימת Cloud Scheduler.
6. בקטע קוד מקור, בוחרים באפשרות 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) => {
     // 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: [] כדי לייצא רק את קבוצות האוספים שצוינו. כדי לייצא את כל קבוצות האוספים, משאירים את השדה כמו שהוא.

   • (אופציונלי) אם אתם משתמשים במסד נתונים שהוא לא ברירת המחדל, הקפידו להגדיר את משתנה הסביבה DATABASE_ID כשאתם יוצרים את הפונקציה של Cloud Functions. אם אתם משתמשים בסביבת זמן ריצה שבה המשתנה GOOGLE_CLOUD_PROJECT לא מוגדר באופן אוטומטי, יכול להיות שתצטרכו להגדיר אותו ידנית או להחליף אותו במזהה הפרויקט בקוד.

7. בקטע package.json, מוסיפים את יחסי התלות הבאים:

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

8. בקטע Function to execute, מזינים את 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. בשדה Topic, מזינים את השם של נושא Pub/Sub שהגדרתם לצד הפונקציה של Cloud Functions, ‏initiateFirestoreExport בדוגמה הקודמת.
7. בשדה Payload, מזינים start export. המשימה דורשת הגדרה של מטען ייעודי (payload), אבל הפונקציה הקודמת של Cloud Functions לא משתמשת בערך הזה בפועל.
8. לוחצים על יצירה.