फ़ंक्शन शेड्यूल करें


अगर आपको फ़ंक्शन को तय समय पर चलाने के लिए शेड्यूल करना है, तो firebase-functions/v2/scheduler के दिए गए onSchedule हैंडलर का इस्तेमाल करें. ये फ़ंक्शन, आपके तय किए गए समय या इंटरवल पर फ़ंक्शन लॉजिक को लागू करने के लिए, Cloud Scheduler का इस्तेमाल करते हैं.

शुरू करने से पहले

अपने Firebase प्रोजेक्ट में इस समाधान का इस्तेमाल करने के लिए, आपका प्रोजेक्ट, Blaze के कीमत वाले प्लान पर होना चाहिए. अगर वह पहले से ब्लेज़ प्लान में नहीं है, तो अपने प्राइसिंग प्लान को अपग्रेड करें.

हालांकि, बिलिंग की ज़रूरत होती है, लेकिन आपको कुल खर्च को मैनेज करने में मदद मिल सकती है. ऐसा इसलिए, क्योंकि हर Cloud Scheduler जॉब के लिए हर महीने 0.10 डॉलर (अमेरिकन डॉलर) का शुल्क लिया जाता है. साथ ही, हर Google खाते के लिए तीन जॉब बिना किसी शुल्क के किए जा सकते हैं. अनुमानित इस्तेमाल के आधार पर, लागत का अनुमान जनरेट करने के लिए, Blaze के प्राइसिंग कैलकुलेटर का इस्तेमाल करें.

आपके प्रोजेक्ट के लिए, Cloud Scheduler एपीआई चालू होना चाहिए. ज़्यादातर Firebase प्रोजेक्ट के लिए यह सुविधा पहले से ही चालू होनी चाहिए. इसकी पुष्टि, Google Cloud Console में जाकर की जा सकती है.

शेड्यूल किया गया फ़ंक्शन लिखना

Cloud Functions for Firebase में, शेड्यूलिंग लॉजिक आपके फ़ंक्शन कोड में मौजूद होता है. साथ ही, डिप्लॉय करने के समय कोई खास ज़रूरी शर्त नहीं होती. उदाहरण के लिए, हर दिन एक बार इनऐक्टिव उपयोगकर्ता खातों को हटाने के लिए, इन इंपोर्ट स्टेटमेंट से शुरू होने वाला फ़ंक्शन लिखा जा सकता है:

Node.js

// The Cloud Functions for Firebase SDK to set up triggers and logging.
const {onSchedule} = require("firebase-functions/v2/scheduler");
const {logger} = require("firebase-functions");

// The Firebase Admin SDK to delete inactive users.
const admin = require("firebase-admin");
admin.initializeApp();

// The es6-promise-pool to limit the concurrency of promises.
const PromisePool = require("es6-promise-pool").default;
// Maximum concurrent account deletions.
const MAX_CONCURRENT = 3;
index.js

Python

# The Cloud Functions for Firebase SDK to set up triggers and logging.
from firebase_functions import scheduler_fn

# The Firebase Admin SDK to delete users.
import firebase_admin
from firebase_admin import auth

firebase_admin.initialize_app()
main.py

इसके बाद, Cloud Scheduler टास्क शुरू करने के लिए onSchedule का इस्तेमाल किया जा सकता है:

Node.js

// Run once a day at midnight, to clean up the users
// Manually run the task here https://console.cloud.google.com/cloudscheduler
exports.accountcleanup = onSchedule("every day 00:00", async (event) => {
  // Fetch all user details.
  const inactiveUsers = await getInactiveUsers();

  // Use a pool so that we delete maximum `MAX_CONCURRENT` users in parallel.
  const promisePool = new PromisePool(
      () => deleteInactiveUser(inactiveUsers),
      MAX_CONCURRENT,
  );
  await promisePool.start();

  logger.log("User cleanup finished");
});
index.js

Python

# Run once a day at midnight, to clean up inactive users.
# Manually run the task here https://console.cloud.google.com/cloudscheduler
@scheduler_fn.on_schedule(schedule="every day 00:00")
def accountcleanup(event: scheduler_fn.ScheduledEvent) -> None:
    """Delete users who've been inactive for 30 days or more."""
    user_page: auth.ListUsersPage | None = auth.list_users()
    while user_page is not None:
        inactive_uids = [
            user.uid for user in user_page.users if is_inactive(user, timedelta(days=30))
        ]
        auth.delete_users(inactive_uids)
        user_page = user_page.get_next_page()
main.py

Cloud Scheduler में, Unix Crontab और App Engine सिंटैक्स, दोनों काम करते हैं. उदाहरण के लिए, Crontab का इस्तेमाल करने के लिए, कुछ ऐसा करें:

Node.js

exports.scheduledFunctionCrontab = onSchedule("5 11 * * *", async (event) => {
  // ...
});

Python

@scheduler_fn.on_schedule(schedule="5 11 * * *")

शेड्यूल किए गए फ़ंक्शन को डिप्लॉय करना

शेड्यूल किया गया फ़ंक्शन डिप्लॉय करने पर, शेड्यूलर जॉब और एचटीटीपी फ़ंक्शन अपने-आप बन जाते हैं. Firebase सीएलआई, फ़ंक्शन का नाम दिखाता है. साथ ही, Google Cloud Console में जॉब और फ़ंक्शन देखे जा सकते हैं. विषय को यहां दिए गए कन्वेंशन के मुताबिक नाम दिया गया है:

firebase-schedule-function_name-region

उदाहरण के लिए:

firebase-schedule-accountcleanup-us-east1.

शेड्यूल किए गए समय पर, Compute का डिफ़ॉल्ट सेवा खाता, उससे जुड़े एचटीटीपी फ़ंक्शन को ट्रिगर करता है. इसका मतलब है कि सिर्फ़ संबंधित Cloud Scheduler नौकरी के पास फ़ंक्शन को चलाने की अनुमति है.