रीयलटाइम डेटाबेस ट्रिगर


Cloud Functions की मदद से, क्लाइंट कोड को अपडेट किए बिना, Firebase Realtime Database में इवेंट मैनेज किए जा सकते हैं. Cloud Functions की मदद से, एडमिन के सभी ऐक्सेस के साथ Realtime Database के ऑपरेशन चलाए जा सकते हैं. साथ ही, यह पक्का किया जा सकता है कि Realtime Database में किए गए हर बदलाव को अलग से प्रोसेस किया जाए. DataSnapshot या Admin SDK की मदद से, Firebase Realtime Database में बदलाव किए जा सकते हैं.

आम तौर पर, लाइफ़साइकल में Firebase Realtime Database फ़ंक्शन ये काम करता है:

  1. किसी खास Realtime Database जगह में बदलाव होने का इंतज़ार करता है.
  2. कोई इवेंट होने पर ट्रिगर होता है और अपने टास्क करता है (Cloud Functions की मदद से क्या किया जा सकता है? देखें) इस्तेमाल के उदाहरणों के लिए).
  3. इसमें एक डेटा ऑब्जेक्ट मिलता है, जिसमें दिए गए दस्तावेज़ में सेव किए गए डेटा का स्नैपशॉट होता है.

Realtime Database फ़ंक्शन को ट्रिगर करना

functions.database की मदद से, Realtime Database इवेंट के लिए नए फ़ंक्शन बनाएं. फ़ंक्शन कब ट्रिगर होगा, यह कंट्रोल करने के लिए, कोई एक इवेंट हैंडलर तय करें. साथ ही, वह Realtime Database पाथ भी तय करें जहां वह इवेंट के लिए सुनेगा.

इवेंट हैंडलर सेट करना

फ़ंक्शन की मदद से, Realtime Database इवेंट को दो लेवल पर मैनेज किया जा सकता है. पहला, सिर्फ़ बनाने, अपडेट करने या मिटाने वाले इवेंट के लिए सुनना. दूसरा, किसी पाथ में हुए किसी भी तरह के बदलाव के लिए सुनना. Cloud Functions, Realtime Database के लिए इन इवेंट हैंडलर के साथ काम करता है:

  • onWrite(), जो Realtime Database में डेटा बनाने, अपडेट करने या मिटाने पर ट्रिगर होता है.
  • onCreate(), जो Realtime Database में नया डेटा बनने पर ट्रिगर होता है.
  • onUpdate(), जो Realtime Database में डेटा अपडेट होने पर ट्रिगर होता है .
  • onDelete(), जो Realtime Database से डेटा मिटाए जाने पर ट्रिगर होता है .

इंस्टेंस और पाथ की जानकारी देना

यह कंट्रोल करने के लिए कि आपका फ़ंक्शन कब और कहां ट्रिगर होना चाहिए, कोई पाथ तय करने के लिए ref(path) को कॉल करें. इसके अलावा, instance('INSTANCE_NAME') की मदद से Realtime Database इंस्टेंस तय करें. हालांकि, ऐसा करना ज़रूरी नहीं है. अगर किसी इंस्टेंस की जानकारी नहीं दी जाती है, तो फ़ंक्शन Firebase प्रोजेक्ट के लिए डिफ़ॉल्ट Realtime Database इंस्टेंस पर डिप्लॉय हो जाता है. उदाहरण के लिए:

  • डिफ़ॉल्ट Realtime Database इंस्टेंस: functions.database.ref('/foo/bar')
  • "my-app-db-2" नाम का इंस्टेंस: functions.database.instance('my-app-db-2').ref('/foo/bar')

ये तरीके आपके फ़ंक्शन को Realtime Database इंस्टेंस में किसी खास पाथ पर लिखने की सुविधा देते हैं. पाथ की जानकारी, किसी पाथ से जुड़े सभी लिखे गए डेटा से मेल खाती है. इसमें, उस पाथ के नीचे कहीं भी लिखे गए डेटा भी शामिल हैं. अगर आपने अपने फ़ंक्शन के लिए पाथ को /foo/bar के तौर पर सेट किया है, तो यह इन दोनों जगहों पर मौजूद इवेंट से मैच करता है:

 /foo/bar
 /foo/bar/baz/really/deep/path

दोनों ही मामलों में, Firebase यह समझता है कि इवेंट /foo/bar पर होता है और इवेंट डेटा में /foo/bar पर मौजूद पुराना और नया डेटा शामिल होता है. अगर इवेंट डेटा बड़ा हो सकता है, तो अपने डेटाबेस के रूट के पास एक फ़ंक्शन के बजाय, गहरे पाथ पर कई फ़ंक्शन इस्तेमाल करें. सबसे अच्छी परफ़ॉर्मेंस के लिए, सिर्फ़ ज़्यादा से ज़्यादा डेटा का अनुरोध करें.

किसी पाथ कॉम्पोनेंट को वाइल्डकार्ड के तौर पर तय करने के लिए, उसे कर्ली ब्रैकेट में डालें. ref('foo/{bar}'), /foo के किसी भी चाइल्ड से मैच करता है. इन वाइल्डकार्ड पाथ कॉम्पोनेंट की वैल्यू, आपके फ़ंक्शन के EventContext.params ऑब्जेक्ट में उपलब्ध होती हैं. इस उदाहरण में, वैल्यू context.params.bar के तौर पर उपलब्ध है.

वाइल्डकार्ड वाले पाथ, एक ही बार लिखे गए कई इवेंट से मैच कर सकते हैं. 

{
  "foo": {
    "hello": "world",
    "firebase": "functions"
  }
}

पाथ "/foo/{bar}" से दो बार मैच करता है: एक बार "hello": "world" के साथ और फिर "firebase": "functions" के साथ.

इवेंट डेटा मैनेज करना

Realtime Database इवेंट को मैनेज करते समय, रिटर्न किया गया डेटा ऑब्जेक्ट एक DataSnapshot होता है. onWrite या onUpdate इवेंट के लिए, पहला पैरामीटर एक Change ऑब्जेक्ट होता है. इसमें दो स्नैपशॉट होते हैं, जो ट्रिगर होने वाले इवेंट से पहले और बाद में डेटा की स्थिति दिखाते हैं. onCreate और onDelete इवेंट के लिए, रिटर्न किया गया डेटा ऑब्जेक्ट, बनाए गए या मिटाए गए डेटा का स्नैपशॉट होता है.

इस उदाहरण में, फ़ंक्शन दिए गए पाथ का स्नैपशॉट लेता है, उस जगह की स्ट्रिंग को अपरकेस में बदलता है, और बदली गई उस स्ट्रिंग को डेटाबेस में लिखता है:

// Listens for new messages added to /messages/:pushId/original and creates an
// uppercase version of the message to /messages/:pushId/uppercase
exports.makeUppercase = functions.database.ref('/messages/{pushId}/original')
    .onCreate((snapshot, context) => {
      // Grab the current value of what was written to the Realtime Database.
      const original = snapshot.val();
      functions.logger.log('Uppercasing', context.params.pushId, original);
      const uppercase = original.toUpperCase();
      // You must return a Promise when performing asynchronous tasks inside a Functions such as
      // writing to the Firebase Realtime Database.
      // Setting an "uppercase" sibling in the Realtime Database returns a Promise.
      return snapshot.ref.parent.child('uppercase').set(uppercase);
    });
index.js

उपयोगकर्ता की पुष्टि करने से जुड़ी जानकारी ऐक्सेस करना

EventContext.auth और EventContext.authType से, उस उपयोगकर्ता की जानकारी ऐक्सेस की जा सकती है जिसने किसी फ़ंक्शन को ट्रिगर किया है. इसमें अनुमतियां भी शामिल हैं. यह सुरक्षा नियमों को लागू करने के लिए फ़ायदेमंद हो सकता है. इससे, आपके फ़ंक्शन को उपयोगकर्ता की अनुमतियों के लेवल के आधार पर अलग-अलग ऑपरेशन पूरे करने की अनुमति मिलती है:

const functions = require('firebase-functions/v1');
const admin = require('firebase-admin');

exports.simpleDbFunction = functions.database.ref('/path')
    .onCreate((snap, context) => {
      if (context.authType === 'ADMIN') {
        // do something
      } else if (context.authType === 'USER') {
        console.log(snap.val(), 'written by', context.auth.uid);
      }
    });

साथ ही, उपयोगकर्ता की पुष्टि करने वाली जानकारी का इस्तेमाल करके, किसी उपयोगकर्ता के "नाम पर काम" किया जा सकता है और उसकी ओर से डेटा में बदलाव किया जा सकता है. एक साथ कई टास्क करने से जुड़ी समस्याओं से बचने के लिए, ऐप्लिकेशन इंस्टेंस को यहां दिखाए गए तरीके से मिटाएं:

exports.impersonateMakeUpperCase = functions.database.ref('/messages/{pushId}/original')
    .onCreate((snap, context) => {
      const appOptions = JSON.parse(process.env.FIREBASE_CONFIG);
      appOptions.databaseAuthVariableOverride = context.auth;
      const app = admin.initializeApp(appOptions, 'app');
      const uppercase = snap.val().toUpperCase();
      const ref = snap.ref.parent.child('uppercase');

      const deleteApp = () => app.delete().catch(() => null);

      return app.database().ref(ref).set(uppercase).then(res => {
        // Deleting the app is necessary for preventing concurrency leaks
        return deleteApp().then(() => res);
      }).catch(err => {
        return deleteApp().then(() => Promise.reject(err));
      });
    });

पिछली वैल्यू पढ़ना

Change ऑब्जेक्ट में एक before प्रॉपर्टी होती है. इसकी मदद से, यह जांचा जा सकता है कि इवेंट शुरू होने से पहले Realtime Database में क्या सेव किया गया था. before प्रॉपर्टी, DataSnapshot दिखाती है, जहां सभी तरीकों (उदाहरण के लिए, val() और exists()) से पिछली वैल्यू का पता चलता है. नई वैल्यू को फिर से पढ़ने के लिए, ओरिजनल DataSnapshot का इस्तेमाल करें या after प्रॉपर्टी को पढ़ें. किसी भी Change पर मौजूद यह प्रॉपर्टी, एक और DataSnapshot है. यह इवेंट होने के बाद डेटा की स्थिति दिखाती है.

उदाहरण के लिए, before प्रॉपर्टी का इस्तेमाल करके यह पक्का किया जा सकता है कि फ़ंक्शन, पहली बार बनाने पर ही टेक्स्ट को अपरकेस में बदले:

exports.makeUppercase = functions.database.ref('/messages/{pushId}/original')
    .onWrite((change, context) => {
      // Only edit data when it is first created.
      if (change.before.exists()) {
        return null;
      }
      // Exit when the data is deleted.
      if (!change.after.exists()) {
        return null;
      }
      // Grab the current value of what was written to the Realtime Database.
      const original = change.after.val();
      console.log('Uppercasing', context.params.pushId, original);
      const uppercase = original.toUpperCase();
      // You must return a Promise when performing asynchronous tasks inside a Functions such as
      // writing to the Firebase Realtime Database.
      // Setting an "uppercase" sibling in the Realtime Database returns a Promise.
      return change.after.ref.parent.child('uppercase').set(uppercase);
    });