Cloud Firestore के ट्रिगर

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

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

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

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

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

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

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

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

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

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

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

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

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

कोई एक दस्तावेज़ तय करें

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

// 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} का इस्तेमाल करें:

// 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 में सेव किए जाते हैं. अश्लील कलेक्शन या दस्तावेज़ के आईडी के तौर पर जितने चाहें उतने वाइल्डकार्ड तय किए जा सकते हैं. उदाहरण के लिए:

// 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 को कॉल करता है:

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 को तब कॉल करता है, जब कोई उपयोगकर्ता अपनी प्रोफ़ाइल बदलता है:

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 को कॉल करता है:

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 को कॉल करता है, अगर उपयोगकर्ता बनाया गया है, अपडेट किया गया है या मिटाया गया है:

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 एडमिन SDK टूल का इस्तेमाल किया जा सकता है.

इवेंट का डेटा

पढ़ने से जुड़ा डेटा

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

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 फ़ंक्शन का इस्तेमाल किया जा सकता है:

// 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() जैसे तरीके शामिल हैं, ताकि आप फ़ंक्शन को ट्रिगर करने वाले दस्तावेज़ में आसानी से बदलाव कर सकें.

// 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 एडमिन SDK का इस्तेमाल करके, पढ़ने और लिखने के लिए:

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