Firestore Bundle Builder (firestore-bundle-builder) एक्सटेंशन, एक एचटीटीपी फ़ंक्शन डिप्लॉय करता है. यह Cloud Firestore डेटा बंडल उपलब्ध कराता है. Firestore दस्तावेज़ों में बंडल तय किए जाते हैं. एक्सटेंशन, एचटीटीपी अनुरोधों के ज़रिए स्टैटिक बाइनरी फ़ाइल डेटा बंडल उपलब्ध कराता है. साथ ही, Firebase Hosting CDN या Cloud Storage का इस्तेमाल करके, कई बिल्ट-इन कैश मेमोरी की सुविधा भी उपलब्ध कराता है. जब कोई बंडल मौजूद नहीं होता है या मौजूदा बंडलों की समयसीमा खत्म हो जाती है, तो यह फ़ंक्शन मांग पर एक नया बंडल बनाएगा और उसे कैश मेमोरी में सेव करेगा.
इस एक्सटेंशन का इस्तेमाल करने के लिए, आपको पहले एक्सटेंशन के एडमिन डैशबोर्ड का इस्तेमाल करके, Firestore में एक या उससे ज़्यादा बंडल स्पेसिफ़िकेशन बनाने होंगे. बंडल स्पेसिफ़िकेशन का इस्तेमाल करके, नाम वाली क्वेरी तय की जाती हैं. जैसे, कलेक्शन क्वेरी और बंडल में जोड़ने के लिए खास दस्तावेज़ पाथ.
बंडल स्पेसिफ़िकेशन में, नाम वाली क्वेरी में इस्तेमाल किए जाने वाले पैरामीटर भी तय किए जा सकते हैं. एचटीटीपी फ़ंक्शन को कॉल करते समय, यूआरएल क्वेरी पैरामीटर का इस्तेमाल करके इन पैरामीटर के लिए वैल्यू सेट की जाती हैं.
ऊपर दिए गए लिंक में कुछ निर्देश दिए गए हैं. इनकी मदद से, एडमिन यूटिलिटी को स्थानीय तौर पर चलाया जा सकता है. वेब ऐप्लिकेशन सेट अप करने के बाद, यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके स्पेसिफ़िकेशन बनाने के लिए, localhost:3000 पर जाएं:
बंडल बनाना और उसे दिखाना
एक्सटेंशन इंस्टॉल करने और बंडल स्पेसिफ़िकेशन बनाने के बाद, एक्सटेंशन की ओर से दिए गए एचटीटीपी एंडपॉइंट को कॉल करके, बंडल बनाए और दिखाए जा सकते हैं.
बंडल की खास जानकारी के आधार पर, अनुरोध किया गया बंडल क्लाइंट की कैश मेमोरी, Firebase Hosting की कैश मेमोरी या Cloud Storage की फ़ाइल से वापस आ सकता है. सभी कैश मेमोरी की समयसीमा खत्म होने पर, नए अनुरोध को पूरा करने के लिए Firestore क्वेरी ट्रिगर होंगी. इससे मांग के हिसाब से बंडल बनाया जा सकेगा.
रीराइट नियम का इस्तेमाल करके, Firebase Hosting की ऐसी साइट सेट अप की जा सकती है जो सर्व फ़ंक्शन की ओर ले जाती है. इससे, Firebase Hosting के सीडीएन की सुविधाओं का फ़ायदा लिया जा सकता है. सीडीएन, आपके बंडल को कई अलग-अलग सर्वर पर कॉपी करते हैं, ताकि आपके उपयोगकर्ता, बंडल को सबसे नज़दीकी सर्वर से अपने-आप लोड कर सकें. यह सबसे सही तरीका है.
Firebase Hosting में इसे सेट अप करने के लिए, नीचे दिए गए कॉन्टेंट के साथ firebase.json फ़ाइल बनाएं या उसमें बदलाव करें. इसके बाद, साइट को डिप्लॉय करें:
{
"hosting": {
"ignore": ["firebase.json", "**/.*", "**/node_modules/**"],
"rewrites": [
{
"source": "/bundles/*",
"function": "ext-firestore-bundle-builder-serve"
}
]
}
}
डिप्लॉय करने के बाद, अपनी साइट के यूआरएल का इस्तेमाल करके, सीडीएन से अपने बंडल ऐक्सेस किए जा सकते हैं. उदाहरण के लिए: https://your-site-url.com/bundles/:bundleId.
इसके अलावा, अगर आपको Firebase Hosting का इस्तेमाल नहीं करना है, तो एक्सटेंशन को Cloud Storage में डेटा को कैश मेमोरी में सेव करने के लिए कॉन्फ़िगर किया जा सकता है. इस मामले में, बंडल जनरेट करने के लिए, डिप्लॉय किए गए एचटीटीपी फ़ंक्शन को सीधे तौर पर कॉल किया जाएगा.
क्लाइंट इंटिग्रेशन
इसके बाद, Cloud Firestore SDK के loadBundle API की मदद से बंडल का इस्तेमाल किया जा सकता है. सबसे पहले बंडल को डाउनलोड करना होगा. इसके बाद, इसे SDK टूल को उपलब्ध कराना होगा. उदाहरण के लिए:
import { loadBundle } from "firebase/firestore";
// Download the bundle from the Firebase Hosting CDN:
const bundle = await fetch("/bundles/:bundleId");
// If not using a CDN, download the bundle directly:
// const bundle = await fetch('https://<location>-<project-id>.cloudfunctions.net/ext-firestore-bundle-builder-serve/:bundleId');
await loadBundle(bundle);
लोड होने के बाद, बंडल में मौजूद डेटा का इस्तेमाल किया जा सकता है:
अगर आपने बंडल तय करते समय, दस्तावेज़ के पाथ का एक कलेक्शन तय किया है, तो बंडल के ज़रिए अपने क्लाइंट पर दस्तावेज़ का डेटा पाया जा सकता है:
import { getFirestore, doc, getDocFromCache } from "firebase/firestore";
// Bundle Document IDs: ['users/92x1NgSWYKUC4AG4s2nHGMR2ikZ2']
const ref = doc(getFirestore(), "users/92x1NgSWYKUC4AG4s2nHGMR2ikZ2");
const snapshot = await getDocFromCache(ref);
अगर आपने क्वेरी तय की हैं, तो बंडल से क्वेरी चलाने के लिए, namedQuery एपीआई का इस्तेमाल किया जा सकता है:
import { getFirestore, namedQuery } from "firebase/firestore";
const query = await namedQuery(getFirestore(), "queryId");
const snapshot = await getDocsFromCache(query);
क्वेरी आईडी को हर queries प्रॉपर्टी की परिभाषा की कुंजी के तौर पर तय किया जाता है. इसके बारे में यहां बताया गया है.