Cloud Functions की मदद से Cloud Firestore का दायरा बढ़ाना (2nd gen)

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

Cloud Functions (2nd gen)

Cloud Run और Eventarc पर काम करने वाले, Cloud Functions for Firebase (2nd gen) से आपको ज़्यादा बेहतर इन्फ़्रास्ट्रक्चर, परफ़ॉर्मेंस और स्केलेबिलिटी पर बेहतर कंट्रोल, और ज़्यादा कंट्रोल मिलता है. 2nd gen के बारे में ज़्यादा जानने के लिए, Firebase के लिए Cloud Functions (2nd gen) लेख पढ़ें.

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

Cloud Functions for Firebase SDK, इन Cloud Firestore इवेंट ट्रिगर को एक्सपोर्ट करता है. इससे, खास Cloud Firestore इवेंट से जुड़े हैंडलर बनाए जा सकते हैं:

Node.js

इवेंट टाइप ट्रिगर
onDocumentCreated जब किसी दस्तावेज़ में पहली बार कुछ लिखा जाता है, तब यह ट्रिगर होता है.
onDocumentUpdated जब कोई दस्तावेज़ पहले से मौजूद हो और उसकी किसी वैल्यू में बदलाव किया गया हो, तब यह ट्रिगर होता है.
onDocumentDeleted जब कोई दस्तावेज़ मिटाया जाता है, तब यह ट्रिगर होता है.
onDocumentWritten जब onDocumentCreated, onDocumentUpdated या onDocumentDeleted ट्रिगर होता है, तब यह ट्रिगर होता है.
onDocumentCreatedWithAuthContext onDocumentCreated के साथ, पुष्टि करने के लिए ज़रूरी अतिरिक्त जानकारी
onDocumentWrittenWithAuthContext onDocumentWritten के साथ, पुष्टि करने के लिए ज़रूरी अतिरिक्त जानकारी
onDocumentDeletedWithAuthContext onDocumentDeleted के साथ, पुष्टि करने के लिए ज़रूरी अतिरिक्त जानकारी
onDocumentUpdatedWithAuthContext onDocumentUpdated के साथ, पुष्टि करने के लिए ज़रूरी अतिरिक्त जानकारी

Python

इवेंट टाइप ट्रिगर
on_document_created जब किसी दस्तावेज़ में पहली बार कुछ लिखा जाता है, तब यह ट्रिगर होता है.
on_document_updated जब कोई दस्तावेज़ पहले से मौजूद हो और उसकी किसी वैल्यू में बदलाव किया गया हो, तब यह ट्रिगर होता है.
on_document_deleted जब कोई दस्तावेज़ मिटाया जाता है, तब यह ट्रिगर होता है.
on_document_written जब on_document_created, on_document_updated या on_document_deleted ट्रिगर होता है, तब यह ट्रिगर होता है.
on_document_created_with_auth_context on_document_created के साथ, पुष्टि करने के लिए ज़रूरी अतिरिक्त जानकारी
on_document_updated_with_auth_context on_document_updated के साथ, पुष्टि करने के लिए ज़रूरी अतिरिक्त जानकारी
on_document_deleted_with_auth_context on_document_deleted के साथ, पुष्टि करने के लिए ज़रूरी अतिरिक्त जानकारी
on_document_written_with_auth_context on_document_written के साथ, पुष्टि करने के लिए ज़रूरी अतिरिक्त जानकारी

Cloud Firestore इवेंट, सिर्फ़ दस्तावेज़ों में होने वाले बदलावों पर ट्रिगर होते हैं. किसी Cloud Firestore दस्तावेज़ में, डेटा में कोई बदलाव न होने पर (नो-ऑप राइट), अपडेट या राइट इवेंट जनरेट नहीं होता. खास फ़ील्ड में इवेंट नहीं जोड़े जा सकते.

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

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

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

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

Node.js

const {
  onDocumentWritten,
  onDocumentCreated,
  onDocumentUpdated,
  onDocumentDeleted,
  Change,
  FirestoreEvent
} = require('firebase-functions/v2/firestore');

exports.myfunction = onDocumentWritten("my-collection/{docId}", (event) => {
   /* ... */ 
});

Python

from firebase_functions.firestore_fn import (
  on_document_created,
  on_document_deleted,
  on_document_updated,
  on_document_written,
  Event,
  Change,
  DocumentSnapshot,
)

@on_document_created(document="users/{userId}")
def myfunction(event: Event[DocumentSnapshot]) -> None:

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

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

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

Node.js

const {
  onDocumentWritten,
  Change,
  FirestoreEvent
} = require('firebase-functions/v2/firestore');

exports.myfunction = onDocumentWritten("users/marie", (event) => {
  // Your code here
});

Python

from firebase_functions.firestore_fn import (
  on_document_written,
  Event,
  Change,
  DocumentSnapshot,
)

@on_document_written(document="users/marie")
def myfunction(event: Event[Change[DocumentSnapshot]]) -> None:

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

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

Node.js

const {
  onDocumentWritten,
  Change,
  FirestoreEvent
} = require('firebase-functions/v2/firestore');

exports.myfunction = onDocumentWritten("users/{userId}", (event) => {
  // If we set `/users/marie` to {name: "Marie"} then
  // event.params.userId == "marie"
  // ... and ...
  // event.data.after.data() == {name: "Marie"}
});

Python

from firebase_functions.firestore_fn import (
  on_document_written,
  Event,
  Change,
  DocumentSnapshot,
)

@on_document_written(document="users/{userId}")
def myfunction(event: Event[Change[DocumentSnapshot]]) -> None:
  # If we set `/users/marie` to {name: "Marie"} then
  event.params["userId"] == "marie"  # True
  # ... and ...
  event.data.after.to_dict() == {"name": "Marie"}  # True

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

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

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

Node.js

const {
  onDocumentWritten,
  Change,
  FirestoreEvent
} = require('firebase-functions/v2/firestore');

exports.myfunction = onDocumentWritten("users/{userId}/{messageCollectionId}/{messageId}", (event) => {
    // If we set `/users/marie/incoming_messages/134` to {body: "Hello"} then
    // event.params.userId == "marie";
    // event.params.messageCollectionId == "incoming_messages";
    // event.params.messageId == "134";
    // ... and ...
    // event.data.after.data() == {body: "Hello"}
});

Python

from firebase_functions.firestore_fn import (
  on_document_written,
  Event,
  Change,
  DocumentSnapshot,
)

@on_document_written(document="users/{userId}/{messageCollectionId}/{messageId}")
def myfunction(event: Event[Change[DocumentSnapshot]]) -> None:
  # If we set `/users/marie/incoming_messages/134` to {body: "Hello"} then
  event.params["userId"] == "marie"  # True
  event.params["messageCollectionId"] == "incoming_messages"  # True
  event.params["messageId"] == "134"  # True
  # ... and ...
  event.data.after.to_dict() == {"body": "Hello"}

आपका ट्रिगर हमेशा किसी दस्तावेज़ की ओर इशारा करना चाहिए. भले ही, वाइल्डकार्ड का इस्तेमाल किया जा रहा हो. उदाहरण के लिए, users/{userId}/{messageCollectionId} मान्य नहीं है, क्योंकि {messageCollectionId} एक कलेक्शन है. हालांकि, users/{userId}/{messageCollectionId}/{messageId} मान्य है क्योंकि {messageId} हमेशा किसी दस्तावेज़ की ओर इशारा करेगा.

इवेंट ट्रिगर

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

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

Node.js

const {
  onDocumentCreated,
  Change,
  FirestoreEvent
} = require('firebase-functions/v2/firestore');

exports.createuser = onDocumentCreated("users/{userId}", (event) => {
    // Get an object representing the document
    // e.g. {'name': 'Marie', 'age': 66}
    const snapshot = event.data;
    if (!snapshot) {
        console.log("No data associated with the event");
        return;
    }
    const data = snapshot.data();

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

    // perform more operations ...
});

पुष्टि करने के लिए ज़रूरी अतिरिक्त जानकारी पाने के लिए, onDocumentCreatedWithAuthContext का इस्तेमाल करें.

Python

from firebase_functions.firestore_fn import (
  on_document_created,
  Event,
  DocumentSnapshot,
)

@on_document_created(document="users/{userId}")
def myfunction(event: Event[DocumentSnapshot]) -> None:
  # Get a dictionary representing the document
  # e.g. {'name': 'Marie', 'age': 66}
  new_value = event.data.to_dict()

  # Access a particular field as you would any dictionary
  name = new_value["name"]

  # Perform more operations ...

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

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

Node.js

const {
  onDocumentUpdated,
  Change,
  FirestoreEvent
} = require('firebase-functions/v2/firestore');

exports.updateuser = onDocumentUpdated("users/{userId}", (event) => {
    // Get an object representing the document
    // e.g. {'name': 'Marie', 'age': 66}
    const newValue = event.data.after.data();

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

    // perform more operations ...
});

पुष्टि करने के लिए ज़रूरी अतिरिक्त जानकारी पाने के लिए, onDocumentUpdatedWithAuthContext का इस्तेमाल करें.

Python

from firebase_functions.firestore_fn import (
  on_document_updated,
  Event,
  Change,
  DocumentSnapshot,
)

@on_document_updated(document="users/{userId}")
def myfunction(event: Event[Change[DocumentSnapshot]]) -> None:
  # Get a dictionary representing the document
  # e.g. {'name': 'Marie', 'age': 66}
  new_value = event.data.after.to_dict()

  # Access a particular field as you would any dictionary
  name = new_value["name"]

  # Perform more operations ...

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

किसी दस्तावेज़ के मिटने पर भी, कोई फ़ंक्शन ट्रिगर किया जा सकता है. इस उदाहरण में दिया गया फ़ंक्शन, किसी उपयोगकर्ता की प्रोफ़ाइल मिटने पर ट्रिगर होता है:

Node.js

const {
  onDocumentDeleted,
  Change,
  FirestoreEvent
} = require('firebase-functions/v2/firestore');

exports.deleteuser = onDocumentDeleted("users/{userId}", (event) => {
    // Get an object representing the document
    // e.g. {'name': 'Marie', 'age': 66}
    const snap =  event.data;
    const data =  snap.data();

    // perform more operations ...
});

पुष्टि करने के लिए ज़रूरी अतिरिक्त जानकारी पाने के लिए, onDocumentDeletedWithAuthContext का इस्तेमाल करें.

Python

from firebase_functions.firestore_fn import (
  on_document_deleted,
  Event,
  DocumentSnapshot,
)

@on_document_deleted(document="users/{userId}")
def myfunction(event: Event[DocumentSnapshot|None]) -> None:
  # Perform more operations ...

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

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

Node.js

const {
  onDocumentWritten,
  Change,
  FirestoreEvent
} = require('firebase-functions/v2/firestore');

exports.modifyuser = onDocumentWritten("users/{userId}", (event) => {
    // Get an object with the current document values.
    // If the document does not exist, it was deleted
    const document =  event.data.after.data();

    // Get an object with the previous document values
    const previousValues =  event.data.before.data();

    // perform more operations ...
});

पुष्टि करने के लिए ज़रूरी अतिरिक्त जानकारी पाने के लिए, onDocumentWrittenWithAuthContext का इस्तेमाल करें.

Python

from firebase_functions.firestore_fn import (
  on_document_written,
  Event,
  Change,
  DocumentSnapshot,
)

@on_document_written(document="users/{userId}")
def myfunction(event: Event[Change[DocumentSnapshot | None]]) -> None:
  # Get an object with the current document values.
  # If the document does not exist, it was deleted.
  document = (event.data.after.to_dict()
              if event.data.after is not None else None)

  # Get an object with the previous document values.
  # If the document does not exist, it was newly created.
  previous_values = (event.data.before.to_dict()
                     if event.data.before is not None else None)

  # Perform more operations ...

डेटा पढ़ना और लिखना

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

इवेंट का डेटा

डेटा पढ़ना

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

Node.js

exports.updateuser2 = onDocumentUpdated("users/{userId}", (event) => {
    // Get an object with the current document values.
    // If the document does not exist, it was deleted
    const newValues =  event.data.after.data();

    // Get an object with the previous document values
    const previousValues =  event.data.before.data();
});

Python

@on_document_updated(document="users/{userId}")
def myfunction(event: Event[Change[DocumentSnapshot]]) -> None:
  # Get an object with the current document values.
  new_value = event.data.after.to_dict()

  # Get an object with the previous document values.
  prev_value = event.data.before.to_dict()

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

Node.js

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

// Fetch data using built in accessor
const experience = event.data.after.data.get('experience');

Python

# Get the value of a single document field.
age = event.data.after.get("age")

# Convert the document to a dictionary.
age = event.data.after.to_dict()["age"]

डेटा लिखना

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

दस्तावेज़ के रेफ़रंस में update(), set(), और remove() जैसे तरीके शामिल होते हैं. इसलिए, उस दस्तावेज़ में बदलाव किया जा सकता है जिससे फ़ंक्शन ट्रिगर हुआ है.

Node.js

const {onDocumentUpdated} = require('firebase-functions/v2/firestore');

exports.countnamechanges = onDocumentUpdated('users/{userId}', (event) => {
  // Retrieve the current and previous value
  const data = event.data.after.data();
  const previousData = event.data.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 event.data.after.ref.set({
    name_change_count: count + 1
  }, {merge: true});

});

Python

@on_document_updated(document="users/{userId}")
def myfunction(event: Event[Change[DocumentSnapshot]]) -> None:
  # Get the current and previous document values.
  new_value = event.data.after
  prev_value = event.data.before

  # We'll only update if the name has changed.
  # This is crucial to prevent infinite loops.
  if new_value.get("name") == prev_value.get("name"):
      return

  # Retrieve the current count of name changes
  count = new_value.to_dict().get("name_change_count", 0)

  # Update the count
  new_value.reference.update({"name_change_count": count + 1})

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

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

Node.js

  • onDocumentCreatedWithAuthContext
  • onDocumentWrittenWithAuthContext
  • onDocumentDeletedWithAuthContext
  • onDocumentUpdatedWithAuthContext

Python

  • on_document_created_with_auth_context
  • on_document_updated_with_auth_context
  • on_document_deleted_with_auth_context
  • on_document_written_with_auth_context

पुष्टि करने के कॉन्टेक्स्ट में उपलब्ध डेटा के बारे में जानने के लिए, पुष्टि करने का कॉन्टेक्स्ट लेख पढ़ें. यहां दिए गए उदाहरण में, पुष्टि करने से जुड़ी जानकारी पाने का तरीका बताया गया है:

Node.js

const {onDocumentWrittenWithAuthContext} = require('firebase-functions/v2/firestore');

exports.syncUser = onDocumentWrittenWithAuthContext("users/{userId}", (event) => {
    const snapshot = event.data.after;
    if (!snapshot) {
        console.log("No data associated with the event");
        return;
    }
    const data = snapshot.data();

    // retrieve auth context from event
    const { authType, authId } = event;

    let verified = false;
    if (authType === "system") {
      // system-generated users are automatically verified
      verified = true;
    } else if (authType === "unknown" || authType === "unauthenticated") {
      // admin users from a specific domain are verified
      if (authId.endsWith("@example.com")) {
        verified = true;
      }
    }

    return data.after.ref.set({
        created_by: authId,
        verified,
    }, {merge: true}); 
}); 

Python

@on_document_updated_with_auth_context(document="users/{userId}")
def myfunction(event: Event[Change[DocumentSnapshot]]) -> None:

  # Get the current and previous document values.
  new_value = event.data.after
  prev_value = event.data.before

  # Get the auth context from the event
  user_auth_type = event.auth_type
  user_auth_id = event.auth_id

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

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

Node.js

const { initializeApp } = require('firebase-admin/app');
const { getFirestore, Timestamp, FieldValue } = require('firebase-admin/firestore');

initializeApp();
const db = getFirestore();

exports.writetofirestore = onDocumentWritten("some/doc", (event) => {
    db.doc('some/otherdoc').set({ ... });
  });

  exports.writetofirestore = onDocumentWritten('users/{userId}', (event) => {
    db.doc('some/otherdoc').set({
      // Update otherdoc
    });
  });

Python

from firebase_admin import firestore, initialize_app
import google.cloud.firestore

initialize_app()

@on_document_written(document="some/doc")
def myfunction(event: Event[Change[DocumentSnapshot | None]]) -> None:
  firestore_client: google.cloud.firestore.Client = firestore.client()
  firestore_client.document("another/doc").set({
      # ...
  })

सीमाएं

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