Cloud Firestore के ट्रिगर


Cloud Functions की मदद से, क्लाइंट कोड को अपडेट किए बिना, Cloud Firestore में इवेंट मैनेज किए जा सकते हैं. दस्तावेज़ के स्नैपशॉट इंटरफ़ेस या Admin SDK की मदद से, Cloud Firestore में बदलाव किए जा सकते हैं.

सामान्य लाइफ़साइकल में, Cloud Firestore फ़ंक्शन ये काम करता है:

  1. किसी खास दस्तावेज़ में बदलाव होने का इंतज़ार किया जाता है.
  2. कोई इवेंट होने पर ट्रिगर होता है और अपने टास्क पूरा करता है.
  3. इसमें एक डेटा ऑब्जेक्ट मिलता है, जिसमें दिए गए दस्तावेज़ में सेव किए गए डेटा का स्नैपशॉट होता है. इवेंट लिखने या अपडेट करने के लिए, डेटा ऑब्जेक्ट में दो स्नैपशॉट होते हैं. ये स्नैपशॉट, ट्रिगर करने वाले इवेंट से पहले और बाद में डेटा की स्थिति दिखाते हैं.

Firestore इंस्टेंस की जगह और फ़ंक्शन की जगह के बीच की दूरी की वजह से, नेटवर्क में देरी हो सकती है. परफ़ॉर्मेंस को ऑप्टिमाइज़ करने के लिए, जहां लागू हो वहां फ़ंक्शन की जगह की जानकारी दें.

Cloud Firestore फ़ंक्शन ट्रिगर

Cloud Functions for Firebase SDK टूल, functions.firestore ऑब्जेक्ट एक्सपोर्ट करता है. इसकी मदद से, Cloud Firestore के खास इवेंट से जुड़े हैंडलर बनाए जा सकते हैं.

इवेंट टाइप ट्रिगर
onCreate जब किसी दस्तावेज़ में पहली बार लिखा जाता है, तब यह ट्रिगर होता है.
onUpdate यह तब ट्रिगर होता है, जब कोई दस्तावेज़ पहले से मौजूद हो और उसकी किसी वैल्यू में बदलाव किया गया हो.
onDelete डेटा वाला कोई दस्तावेज़ मिटाए जाने पर ट्रिगर होता है.
onWrite onCreate, onUpdate या onDelete ट्रिगर होने पर ट्रिगर होता है.

अगर आपने Cloud Functions for Firebase के लिए अब तक कोई प्रोजेक्ट चालू नहीं किया है, तो Cloud Functions for Firebase प्रोजेक्ट को कॉन्फ़िगर और सेट अप करने के लिए, शुरू करें: अपने पहले फ़ंक्शन लिखें और डिप्लॉय करें लेख पढ़ें.

Cloud Firestore से ट्रिगर होने वाले फ़ंक्शन लिखना

फ़ंक्शन ट्रिगर तय करना

Cloud Firestore ट्रिगर तय करने के लिए, दस्तावेज़ का पाथ और इवेंट का टाइप बताएं:

Node.js

const functions = require('firebase-functions');

exports.myFunction = functions.firestore
  .document('my-collection/{docId}')
  .onWrite((change, context) => { /* ... */ });

दस्तावेज़ के पाथ, किसी खास दस्तावेज़ या वाइल्डकार्ड पैटर्न का रेफ़रंस दे सकते हैं.

कोई एक दस्तावेज़ चुनना

अगर आपको किसी दस्तावेज़ में किसी भी बदलाव के लिए इवेंट ट्रिगर करना है, तो यहां दिए गए फ़ंक्शन का इस्तेमाल करें.

Node.js

// Listen for any change on document `marie` in collection `users`
exports.myFunctionName = functions.firestore
    .document('users/marie').onWrite((change, context) => {
      // ... Your code here
    });
index.js

वाइल्डकार्ड का इस्तेमाल करके दस्तावेज़ों का ग्रुप तय करना

अगर आपको दस्तावेज़ों के किसी ग्रुप, जैसे कि किसी कलेक्शन में मौजूद किसी दस्तावेज़ से ट्रिगर अटैच करना है, तो दस्तावेज़ आईडी के बजाय {wildcard} का इस्तेमाल करें:

Node.js

// Listen for changes in all documents in the 'users' collection
exports.useWildcard = functions.firestore
    .document('users/{userId}')
    .onWrite((change, context) => {
      // If we set `/users/marie` to {name: "Marie"} then
      // context.params.userId == "marie"
      // ... and ...
      // change.after.data() == {name: "Marie"}
    });
index.js

इस उदाहरण में, जब users में मौजूद किसी भी दस्तावेज़ का कोई फ़ील्ड बदला जाता है, तो यह userId नाम के वाइल्डकार्ड से मैच होता है.

अगर users में मौजूद किसी दस्तावेज़ में सब-कलेक्शन हैं और उनमें से किसी एक सब-कलेक्शन के दस्तावेज़ में कोई फ़ील्ड बदला जाता है, तो userId वाइल्डकार्ड ट्रिगर नहीं होता.

वाइल्डकार्ड से मैच होने वाले शब्दों को दस्तावेज़ के पाथ से निकालकर, context.params में सेव किया जाता है. साफ़ तौर पर इकट्ठा किए गए कलेक्शन या दस्तावेज़ के आईडी को बदलने के लिए, जितने चाहें उतने वाइल्डकार्ड तय किए जा सकते हैं. उदाहरण के लिए:

Node.js

// Listen for changes in all documents in the 'users' collection and all subcollections
exports.useMultipleWildcards = functions.firestore
    .document('users/{userId}/{messageCollectionId}/{messageId}')
    .onWrite((change, context) => {
      // If we set `/users/marie/incoming_messages/134` to {body: "Hello"} then
      // context.params.userId == "marie";
      // context.params.messageCollectionId == "incoming_messages";
      // context.params.messageId == "134";
      // ... and ...
      // change.after.data() == {body: "Hello"}
    });
index.js

इवेंट ट्रिगर

नया दस्तावेज़ बनाने पर कोई फ़ंक्शन ट्रिगर करना

किसी कलेक्शन में नया दस्तावेज़ बनने पर, फ़ंक्शन को ट्रिगर किया जा सकता है. इसके लिए, वाइल्डकार्ड के साथ onCreate() हैंडलर का इस्तेमाल करें. इस उदाहरण में, जब भी कोई नई उपयोगकर्ता प्रोफ़ाइल जोड़ी जाती है, तो फ़ंक्शन createUser को कॉल किया जाता है:

Node.js

exports.createUser = functions.firestore
    .document('users/{userId}')
    .onCreate((snap, context) => {
      // Get an object representing the document
      // e.g. {'name': 'Marie', 'age': 66}
      const newValue = snap.data();

      // access a particular field as you would any JS property
      const name = newValue.name;

      // perform desired operations ...
    });
index.js

दस्तावेज़ के अपडेट होने पर फ़ंक्शन ट्रिगर करें

वाइल्डकार्ड के साथ onUpdate() फ़ंक्शन का इस्तेमाल करके, दस्तावेज़ को अपडेट करने पर भी फ़ंक्शन को सक्रिय करने के लिए ट्रिगर किया जा सकता है. अगर कोई उपयोगकर्ता अपनी प्रोफ़ाइल बदलता है, तो यह उदाहरण फ़ंक्शन updateUser को कॉल करता है:

Node.js

exports.updateUser = functions.firestore
    .document('users/{userId}')
    .onUpdate((change, context) => {
      // Get an object representing the document
      // e.g. {'name': 'Marie', 'age': 66}
      const newValue = change.after.data();

      // ...or the previous value before this update
      const previousValue = change.before.data();

      // access a particular field as you would any JS property
      const name = newValue.name;

      // perform desired operations ...
    });
index.js

दस्तावेज़ मिटाए जाने पर कोई फ़ंक्शन ट्रिगर करना

वाइल्डकार्ड के साथ onDelete() फ़ंक्शन का इस्तेमाल करके, किसी दस्तावेज़ के मिटने पर भी फ़ंक्शन को ट्रिगर किया जा सकता है. इस उदाहरण में, उपयोगकर्ता अपनी प्रोफ़ाइल मिटाने पर, फ़ंक्शन deleteUser को कॉल करता है:

Node.js

exports.deleteUser = functions.firestore
    .document('users/{userID}')
    .onDelete((snap, context) => {
      // Get an object representing the document prior to deletion
      // e.g. {'name': 'Marie', 'age': 66}
      const deletedValue = snap.data();

      // perform desired operations ...
    });
index.js

दस्तावेज़ में किए गए सभी बदलावों के लिए कोई फ़ंक्शन ट्रिगर करना

अगर आपको फ़ायर किए जा रहे इवेंट के टाइप की परवाह नहीं है, तो वाइल्डकार्ड के साथ onWrite() फ़ंक्शन का इस्तेमाल करके, Cloud Firestore दस्तावेज़ में हुए सभी बदलावों को ट्रैक किया जा सकता है. इस उदाहरण में, modifyUser को कॉल किया जाता है, अगर कोई उपयोगकर्ता बनाया जाता है, अपडेट किया जाता है या मिटाया जाता है:

Node.js

exports.modifyUser = functions.firestore
    .document('users/{userID}')
    .onWrite((change, context) => {
      // Get an object with the current document value.
      // If the document does not exist, it has been deleted.
      const document = change.after.exists ? change.after.data() : null;

      // Get an object with the previous document value (for update or delete)
      const oldDocument = change.before.data();

      // perform desired operations ...
    });
index.js

डेटा पढ़ना और उसमें बदलाव करना

जब कोई फ़ंक्शन ट्रिगर किया जाता है, तो वह इवेंट से जुड़े डेटा का स्नैपशॉट देता है. इस स्नैपशॉट का इस्तेमाल, इवेंट को ट्रिगर करने वाले दस्तावेज़ को पढ़ने या उसमें लिखने के लिए किया जा सकता है. इसके अलावा, अपने डेटाबेस के अन्य हिस्सों को ऐक्सेस करने के लिए, Firebase Admin SDK टूल का इस्तेमाल किया जा सकता है.

इवेंट का डेटा

डेटा पढ़ना

जब कोई फ़ंक्शन ट्रिगर होता है, तब हो सकता है कि आप अपडेट किए गए दस्तावेज़ से डेटा पाना चाहें या अपडेट करने से पहले डेटा पाना चाहें. change.before.data() का इस्तेमाल करके, पिछला डेटा पाया जा सकता है. इसमें अपडेट से पहले के दस्तावेज़ का स्नैपशॉट होता है. इसी तरह, change.after.data() में अपडेट के बाद दस्तावेज़ के स्नैपशॉट की स्थिति शामिल होती है.

Node.js

exports.updateUser2 = functions.firestore
    .document('users/{userId}')
    .onUpdate((change, context) => {
      // Get an object representing the current document
      const newValue = change.after.data();

      // ...or the previous value before this update
      const previousValue = change.before.data();
    });
index.js

प्रॉपर्टी को किसी भी दूसरे ऑब्जेक्ट की तरह ऐक्सेस किया जा सकता है. इसके अलावा, चुनिंदा फ़ील्ड ऐक्सेस करने के लिए, get फ़ंक्शन का इस्तेमाल किया जा सकता है:

Node.js

// Fetch data using standard accessors
const age = snap.data().age;
const name = snap.data()['name'];

// Fetch data using built in accessor
const experience = snap.get('experience');
index.js

डेटा लिखना

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

यह DocumentReference Cloud Firestore Node.js SDK टूल से लिया गया है. इसमें update(), set(), और remove() जैसे तरीके शामिल हैं, ताकि आप फ़ंक्शन को ट्रिगर करने वाले दस्तावेज़ में आसानी से बदलाव कर सकें.

Node.js

// Listen for updates to any `user` document.
exports.countNameChanges = functions.firestore
    .document('users/{userId}')
    .onUpdate((change, context) => {
      // Retrieve the current and previous value
      const data = change.after.data();
      const previousData = change.before.data();

      // We'll only update if the name has changed.
      // This is crucial to prevent infinite loops.
      if (data.name == previousData.name) {
        return null;
      }

      // Retrieve the current count of name changes
      let count = data.name_change_count;
      if (!count) {
        count = 0;
      }

      // Then return a promise of a set operation to update the count
      return change.after.ref.set({
        name_change_count: count + 1
      }, {merge: true});
    });
index.js

ट्रिगर इवेंट के बाहर का डेटा

Cloud Functions भरोसेमंद एनवायरमेंट में चलाया जा सकता है. इसका मतलब है कि उन्हें आपके प्रोजेक्ट में सेवा खाते के तौर पर अनुमति मिली है. Firebase Admin SDK का इस्तेमाल करके, डेटा को पढ़ा और लिखा जा सकता है:

Node.js

const admin = require('firebase-admin');
admin.initializeApp();

const db = admin.firestore();

exports.writeToFirestore = functions.firestore
  .document('some/doc')
  .onWrite((change, context) => {
    db.doc('some/otherdoc').set({ ... });
  });

सीमाएं

Cloud Functions के लिए Cloud Firestore ट्रिगर की इन सीमाओं का ध्यान रखें:

  • Cloud Functions (1st gen) के लिए, Firestore नेटिव मोड में पहले से मौजूद "(डिफ़ॉल्ट)" डेटाबेस ज़रूरी है. यह Cloud Firestore नाम वाले डेटाबेस या डेटास्टोर मोड के साथ काम नहीं करता. ऐसे मामलों में इवेंट कॉन्फ़िगर करने के लिए, कृपया Cloud Functions (दूसरी जनरेशन) का इस्तेमाल करें.
  • ऑर्डर मिलने की कोई गारंटी नहीं है. तेज़ी से होने वाले बदलावों की वजह से, फ़ंक्शन को अनचाहे क्रम में ट्रिगर किया जा सकता है.
  • इवेंट कम से कम एक बार डिलीवर किए जाते हैं. हालांकि, किसी एक इवेंट की वजह से कई फ़ंक्शन ट्रिगर हो सकते हैं. एक बार इस्तेमाल होने वाली मैकेनिक्स पर निर्भर करने से बचें और idempostent फ़ंक्शन लिखें.
  • डेटास्टोर मोड में Cloud Firestore के लिए, Cloud Functions (दूसरी जनरेशन) की ज़रूरत होती है. Cloud Functions (1st gen) में Datastore मोड काम नहीं करता.
  • ट्रिगर, किसी एक डेटाबेस से जुड़ा होता है. एक से ज़्यादा डेटाबेस से मैच करने वाला ट्रिगर नहीं बनाया जा सकता.
  • किसी डेटाबेस को मिटाने से, उस डेटाबेस के लिए कोई भी ट्रिगर अपने-आप नहीं मिटता. ट्रिगर इवेंट डिलीवर करना बंद कर देता है, लेकिन जब तक आप ट्रिगर को मिटा नहीं देते, तब तक वह मौजूद रहता है.
  • अगर मैच होने वाला इवेंट, अनुरोध का ज़्यादा से ज़्यादा साइज़ से ज़्यादा है, तो हो सकता है कि इवेंट को Cloud Functions (पहले जनरेशन) पर डिलीवर न किया जाए.
    • अनुरोध के साइज़ की वजह से डिलीवर नहीं किए गए इवेंट, प्लैटफ़ॉर्म लॉग में लॉग किए जाते हैं और इन्हें प्रोजेक्ट के लिए लॉग के इस्तेमाल में गिना जाता है.
    • आपको ये लॉग, लॉग एक्सप्लोरर में "इवेंट को Cloud फ़ंक्शन में डिलीवर नहीं किया जा सकता, क्योंकि इसका साइज़, पहले जनरेशन की सीमा से ज़्यादा है..." मैसेज के साथ मिलेंगे. इनकी गंभीरता error होती है. functionName फ़ील्ड में, फ़ंक्शन का नाम देखा जा सकता है. अगर receiveTimestamp फ़ील्ड अब भी एक घंटे के अंदर है, तो टाइमस्टैंप से पहले और बाद के स्नैपशॉट के साथ, उस दस्तावेज़ को पढ़कर, इवेंट के असल कॉन्टेंट का अनुमान लगाया जा सकता है.
    • इस तरह के कैडेंस से बचने के लिए, ये काम किए जा सकते हैं:
      • Cloud Functions (2nd gen) पर माइग्रेट और अपग्रेड करना
      • दस्तावेज़ का साइज़ छोटा करें
      • जिस Cloud Functions को मिटाना है उसे मिटाएं
    • बाहर रखे गए यूआरएल का इस्तेमाल करके, लॉगिंग की सुविधा को बंद किया जा सकता है. हालांकि, ध्यान रखें कि समस्या वाले इवेंट अब भी डिलीवर नहीं किए जाएंगे.