Cloud Functions (पहली जनरेशन) की मदद से Cloud Firestore की सुविधाओं को बढ़ाना

Cloud Functions की मदद से, Node.js कोड को डिप्लॉय किया जा सकता है. इससे, Cloud Firestore डेटाबेस में होने वाले बदलावों से ट्रिगर होने वाले इवेंट को मैनेज किया जा सकता है. इससे, अपने सर्वर चलाए बिना ही, अपने ऐप्लिकेशन में सर्वर-साइड की सुविधा आसानी से जोड़ी जा सकती है.

इस्तेमाल के उदाहरणों के लिए, Cloud Functions की मदद से क्या किया जा सकता है Cloud Functions? या Functions Samples GitHub रिपॉज़िटरी देखें.

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 (पहली जनरेशन) के लिए, Firestore के नेटिव मोड में "(default)" डेटाबेस का होना ज़रूरी है. यह नाम वाले डेटाबेस या Datastore मोड के साथ काम नहीं करता.Cloud Firestore ऐसे मामलों में, इवेंट कॉन्फ़िगर करने के लिए, Cloud Functions (दूसरी जनरेशन) का इस्तेमाल करें.
  • Cloud Functions और Cloud Firestore ट्रिगर के साथ, अलग-अलग प्रोजेक्ट सेट अप करना एक सीमा है. Cloud Firestore ट्रिगर सेट अप करने के लिए, Cloud Functions एक ही प्रोजेक्ट में होने चाहिए.
  • क्रम की कोई गारंटी नहीं है. तेज़ी से होने वाले बदलावों की वजह से, फ़ंक्शन कॉल अनचाहे क्रम में ट्रिगर हो सकते हैं.
  • इवेंट कम से कम एक बार डिलीवर किए जाते हैं, लेकिन एक इवेंट की वजह से कई फ़ंक्शन कॉल हो सकते हैं. एक बार होने वाले मेकेनिज़्म पर निर्भर न रहें और आइडमपोटेंट फ़ंक्शन लिखें.
  • Datastore मोड में Cloud Firestore के लिए, Cloud Functions (दूसरी जनरेशन) की ज़रूरत होती है. Cloud Functions (पहली जनरेशन), Datastore मोड के साथ काम नहीं करता.
  • एक ट्रिगर, किसी एक डेटाबेस से जुड़ा होता है. ऐसा ट्रिगर नहीं बनाया जा सकता जो एक से ज़्यादा डेटाबेस से मैच करे.
  • किसी डेटाबेस को मिटाने पर, उस डेटाबेस के लिए कोई भी ट्रिगर अपने-आप नहीं मिटता. ट्रिगर, इवेंट डिलीवर करना बंद कर देता है, लेकिन जब तक उसे मिटाया नहीं जाता, तब तक वह मौजूद रहता है.
  • अगर मैच किया गया कोई इवेंट, अनुरोध के साइज़ की तय सीमा से ज़्यादा है, तो हो सकता है कि वह Cloud Functions (पहली जनरेशन) को डिलीवर न किया जाए.