Cloud Firestore के डेटा बंडल

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

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

Cloud Firestore के डेटा बंडल इस तरह बनाए गए हैं कि ये दूसरे Firebase के साथ बेहतर तरीके से काम कर सकें बैकएंड प्रॉडक्ट. इंटिग्रेट किए गए समाधान के बारे में जानकारी जिसमें Cloud Functions ने बंडल बनाए और Firebase Hosting.

ऐप्लिकेशन के साथ बंडल का इस्तेमाल करने के लिए, इन तीन चरणों को पूरा करना होगा:

  1. एडमिन SDK टूल की मदद से बंडल बनाना
  2. बंडल को स्थानीय स्टोरेज से या सीडीएन से पेश करना
  3. क्लाइंट में बंडल लोड किए जा रहे हैं

डेटा बंडल क्या है?

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

नाम वाली क्वेरी, बंडल की एक असरदार सुविधा है. नाम वाली क्वेरी ये हैं Query ऑब्जेक्ट को बंडल से निकालें. इसके बाद, तुरंत इस्तेमाल करें कैश मेमोरी या बैकएंड से डेटा के बारे में क्वेरी करने के लिए, जैसा कि आप आम तौर पर किसी भी जो Cloud Firestore से बात करता है.

सर्वर पर डेटा बंडल बनाना

Node.js या Java Admin SDK का इस्तेमाल करने से बंडल में क्या शामिल करना है और उन्हें कैसे दिखाना है, इसके लिए कंट्रोल भी बनाए जा सकते हैं.

Node.js
var bundleId = "latest-stories";

var bundle = firestore.bundle(bundleId);

var docSnapshot = await firestore.doc('stories/stories').get();
var querySnapshot = await firestore.collection('stories').get();

// Build the bundle
// Note how querySnapshot is named "latest-stories-query"
var bundleBuffer = bundle.add(docSnapshot); // Add a document
                   .add('latest-stories-query', querySnapshot) // Add a named query.
                   .build()
      
Java
Firestore db = FirestoreClient.getFirestore(app);

// Query the 50 latest stories
QuerySnapshot latestStories = db.collection("stories")
    .orderBy("timestamp", Direction.DESCENDING)
    .limit(50)
    .get()
    .get();

// Build the bundle from the query results
FirestoreBundle bundle = db.bundleBuilder("latest-stories")
    .add("latest-stories-query", latestStories)
    .build();
      
Python
from google.cloud import firestore
from google.cloud.firestore_bundle import FirestoreBundle

db = firestore.Client()
bundle = FirestoreBundle("latest-stories")

doc_snapshot = db.collection("stories").document("news-item").get()
query = db.collection("stories")._query()

# Build the bundle
# Note how `query` is named "latest-stories-query"
bundle_buffer: str = bundle.add_document(doc_snapshot).add_named_query(
    "latest-stories-query", query,
).build()
      

डेटा बंडल दिखाए जा रहे हैं

आप किसी सीडीएन से या डाउनलोड करके अपने क्लाइंट ऐप्लिकेशन को बंडल दिखा सकते हैं उदाहरण के लिए, Cloud Storage से.

मान लें कि पिछले सेक्शन में बनाए गए बंडल को bundle.txt नाम वाली फ़ाइल में सेव किया गया और सर्वर पर पोस्ट किया गया. यह बंडल फ़ाइल, किसी भी ऐसी ऐसेट की तरह है जिसे वेब पर दिखाया जा सकता है, जैसा कि यहां दिखाया गया है Node.js Express ऐप्लिकेशन का इस्तेमाल करें.

const fs = require('fs');
const server = require('http').createServer();

server.on('request', (req, res) => {
  const src = fs.createReadStream('./bundle.txt');
  src.pipe(res);
});

server.listen(8000);

क्लाइंट में डेटा बंडल लोड हो रहे हैं

Firebase बंडल को रिमोट सर्वर से फ़ेच करके, उन्हें लोड किया जाता है. भले ही, बंडल को किसी रिमोट सर्वर से फ़ेच किया गया हो कोई एचटीटीपी अनुरोध करके, Storage API को कॉल करके या किसी दूसरी तकनीक का इस्तेमाल करके का इस्तेमाल करें.

फ़ेच किए जाने के बाद, Cloud Firestore क्लाइंट SDK टूल का इस्तेमाल करके, आपका ऐप्लिकेशन loadBundle तरीका इस्तेमाल करता है, जो एक टास्क ट्रैकिंग ऑब्जेक्ट दिखाता है, प्रॉमिस का स्टेटस मॉनिटर करने के साथ-साथ, उस प्रॉमिस का स्टेटस भी मॉनिटर किया जा सकता है. बंडल लोड होने का टास्क पूरा होने पर, बंडल का कॉन्टेंट यहां उपलब्ध होता है लोकल कैश मेमोरी में सेव किया जाएगा.

Web

import { loadBundle, namedQuery, getDocsFromCache } from "firebase/firestore";

async function fetchFromBundle() {
  // Fetch the bundle from Firebase Hosting, if the CDN cache is hit the 'X-Cache'
  // response header will be set to 'HIT'
  const resp = await fetch('/createBundle');

  // Load the bundle contents into the Firestore SDK
  await loadBundle(db, resp.body);

  // Query the results from the cache
  const query = await namedQuery(db, 'latest-stories-query');
  const storiesSnap = await getDocsFromCache(query);

  // Use the results
  // ...
}

Web

// If you are using module bundlers.
import firebase from "firebase/app";
import "firebase/firestore";
import "firebase/firestore/bundle"; // This line enables bundle loading as a side effect.

// ...

async function fetchFromBundle() {
  // Fetch the bundle from Firebase Hosting, if the CDN cache is hit the 'X-Cache'
  // response header will be set to 'HIT'
  const resp = await fetch('/createBundle');

  // Load the bundle contents into the Firestore SDK
  await db.loadBundle(resp.body);

  // Query the results from the cache
  // Note: omitting "source: cache" will query the Firestore backend.
  const query = await db.namedQuery('latest-stories-query');
  const storiesSnap = await query.get({ source: 'cache' });

  // Use the results
  // ...
}
Swift
ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.
// Utility function for errors when loading bundles.
func bundleLoadError(reason: String) -> NSError {
  return NSError(domain: "FIRSampleErrorDomain",
                 code: 0,
                 userInfo: [NSLocalizedFailureReasonErrorKey: reason])
}

func fetchRemoteBundle(for firestore: Firestore,
                       from url: URL) async throws -> LoadBundleTaskProgress {
  guard let inputStream = InputStream(url: url) else {
    let error = self.bundleLoadError(reason: "Unable to create stream from the given url: \(url)")
    throw error
  }

  return try await firestore.loadBundle(inputStream)
}

// Fetches a specific named query from the provided bundle.
func loadQuery(named queryName: String,
               fromRemoteBundle bundleURL: URL,
               with store: Firestore) async throws -> Query {
  let _ = try await fetchRemoteBundle(for: store, from: bundleURL)
  if let query = await store.getQuery(named: queryName) {
    return query
  } else {
    throw bundleLoadError(reason: "Could not find query named \(queryName)")
  }
}

// Load a query and fetch its results from a bundle.
func runStoriesQuery() async {
  let queryName = "latest-stories-query"
  let firestore = Firestore.firestore()
  let remoteBundle = URL(string: "https://example.com/createBundle")!

  do {
    let query = try await loadQuery(named: queryName,
                                    fromRemoteBundle: remoteBundle,
                                    with: firestore)
    let snapshot = try await query.getDocuments()
    print(snapshot)
    // handle query results
  } catch {
    print(error)
  }
}
Objective-C
ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.
// Utility function for errors when loading bundles.
- (NSError *)bundleLoadErrorWithReason:(NSString *)reason {
  return [NSError errorWithDomain:@"FIRSampleErrorDomain"
                             code:0
                         userInfo:@{NSLocalizedFailureReasonErrorKey: reason}];
}

// Loads a remote bundle from the provided url.
- (void)fetchRemoteBundleForFirestore:(FIRFirestore *)firestore
                              fromURL:(NSURL *)url
                           completion:(void (^)(FIRLoadBundleTaskProgress *_Nullable,
                                                NSError *_Nullable))completion {
  NSInputStream *inputStream = [NSInputStream inputStreamWithURL:url];
  if (inputStream == nil) {
    // Unable to create input stream.
    NSError *error =
        [self bundleLoadErrorWithReason:
            [NSString stringWithFormat:@"Unable to create stream from the given url: %@", url]];
    completion(nil, error);
    return;
  }

  [firestore loadBundleStream:inputStream
                   completion:^(FIRLoadBundleTaskProgress * _Nullable progress,
                                NSError * _Nullable error) {
    if (progress == nil) {
      completion(nil, error);
      return;
    }

    if (progress.state == FIRLoadBundleTaskStateSuccess) {
      completion(progress, nil);
    } else {
      NSError *concreteError =
          [self bundleLoadErrorWithReason:
              [NSString stringWithFormat:
                  @"Expected bundle load to be completed, but got %ld instead",
                  (long)progress.state]];
      completion(nil, concreteError);
    }
    completion(nil, nil);
  }];
}

// Loads a bundled query.
- (void)loadQueryNamed:(NSString *)queryName
   fromRemoteBundleURL:(NSURL *)url
         withFirestore:(FIRFirestore *)firestore
            completion:(void (^)(FIRQuery *_Nullable, NSError *_Nullable))completion {
  [self fetchRemoteBundleForFirestore:firestore
                              fromURL:url
                           completion:^(FIRLoadBundleTaskProgress *progress, NSError *error) {
    if (error != nil) {
      completion(nil, error);
      return;
    }

    [firestore getQueryNamed:queryName completion:^(FIRQuery *query) {
      if (query == nil) {
        NSString *errorReason =
            [NSString stringWithFormat:@"Could not find query named %@", queryName];
        NSError *error = [self bundleLoadErrorWithReason:errorReason];
        completion(nil, error);
        return;
      }
      completion(query, nil);
    }];
  }];
}

- (void)runStoriesQuery {
  NSString *queryName = @"latest-stories-query";
  FIRFirestore *firestore = [FIRFirestore firestore];
  NSURL *bundleURL = [NSURL URLWithString:@"https://example.com/createBundle"];
  [self loadQueryNamed:queryName
   fromRemoteBundleURL:bundleURL
         withFirestore:firestore
            completion:^(FIRQuery *query, NSError *error) {
    // Handle query results
  }];
}

Kotlin+KTX

@Throws(IOException::class)
fun getBundleStream(urlString: String?): InputStream {
    val url = URL(urlString)
    val connection = url.openConnection() as HttpURLConnection
    return connection.inputStream
}

@Throws(IOException::class)
fun fetchFromBundle() {
    val bundleStream = getBundleStream("https://example.com/createBundle")
    val loadTask = db.loadBundle(bundleStream)

    // Chain the following tasks
    // 1) Load the bundle
    // 2) Get the named query from the local cache
    // 3) Execute a get() on the named query
    loadTask.continueWithTask<Query> { task ->
        // Close the stream
        bundleStream.close()

        // Calling .result propagates errors
        val progress = task.getResult(Exception::class.java)

        // Get the named query from the bundle cache
        db.getNamedQuery("latest-stories-query")
    }.continueWithTask { task ->
        val query = task.getResult(Exception::class.java)!!

        // get() the query results from the cache
        query.get(Source.CACHE)
    }.addOnCompleteListener { task ->
        if (!task.isSuccessful) {
            Log.w(TAG, "Bundle loading failed", task.exception)
            return@addOnCompleteListener
        }

        // Get the QuerySnapshot from the bundle
        val storiesSnap = task.result

        // Use the results
        // ...
    }
}

Java

public InputStream getBundleStream(String urlString) throws IOException {
    URL url = new URL(urlString);
    HttpURLConnection connection = (HttpURLConnection) url.openConnection();
    return connection.getInputStream();
}

public void fetchBundleFrom() throws IOException {
    final InputStream bundleStream = getBundleStream("https://example.com/createBundle");
    LoadBundleTask loadTask = db.loadBundle(bundleStream);

    // Chain the following tasks
    // 1) Load the bundle
    // 2) Get the named query from the local cache
    // 3) Execute a get() on the named query
    loadTask.continueWithTask(new Continuation<LoadBundleTaskProgress, Task<Query>>() {
        @Override
        public Task<Query> then(@NonNull Task<LoadBundleTaskProgress> task) throws Exception {
            // Close the stream
            bundleStream.close();

            // Calling getResult() propagates errors
            LoadBundleTaskProgress progress = task.getResult(Exception.class);

            // Get the named query from the bundle cache
            return db.getNamedQuery("latest-stories-query");
        }
    }).continueWithTask(new Continuation<Query, Task<QuerySnapshot>>() {
        @Override
        public Task<QuerySnapshot> then(@NonNull Task<Query> task) throws Exception {
            Query query = task.getResult(Exception.class);

            // get() the query results from the cache
            return query.get(Source.CACHE);
        }
    }).addOnCompleteListener(new OnCompleteListener<QuerySnapshot>() {
        @Override
        public void onComplete(@NonNull Task<QuerySnapshot> task) {
            if (!task.isSuccessful()) {
                Log.w(TAG, "Bundle loading failed", task.getException());
                return;
            }

            // Get the QuerySnapshot from the bundle
            QuerySnapshot storiesSnap = task.getResult();

            // Use the results
            // ...
        }
    });
}
C++
db->LoadBundle("bundle_name", [](const LoadBundleTaskProgress& progress) {
  switch(progress.state()) {
    case LoadBundleTaskProgress::State::kError: {
      // The bundle load has errored. Handle the error in the returned future.
      return;
    }
    case LoadBundleTaskProgress::State::kInProgress: {
      std::cout << "Bytes loaded from bundle: " << progress.bytes_loaded()
                << std::endl;
      break;
    }
    case LoadBundleTaskProgress::State::kSuccess: {
      std::cout << "Bundle load succeeeded" << std::endl;
      break;
    }
  }
}).OnCompletion([db](const Future<LoadBundleTaskProgress>& future) {
  if (future.error() != Error::kErrorOk) {
    // Handle error...
    return;
  }

  const std::string& query_name = "latest_stories_query";
  db->NamedQuery(query_name).OnCompletion([](const Future<Query>& query_future){
    if (query_future.error() != Error::kErrorOk) {
      // Handle error...
      return;
    }

    const Query* query = query_future.result();
    query->Get().OnCompletion([](const Future<QuerySnapshot> &){
      // ...
    });
  });
});

ध्यान दें कि अगर 30 मिनट से कम समय में बने बंडल से, नाम वाली क्वेरी लोड की जाती है पहले, कैश के बजाय बैकएंड से पढ़ने के लिए इसका इस्तेमाल करने के बाद, डेटाबेस में मौजूद सिर्फ़ उन चीज़ों के लिए पेमेंट करता है जिनकी ज़रूरत दस्तावेज़ को अपडेट करने में होती है. बैकएंड पर सेव होता है; इसका मतलब है कि आपको सिर्फ़ डेल्टा के लिए पैसे चुकाने हैं.

आगे क्या करना है?