डेटा ऑफ़लाइन एक्सेस करें

क्लाउड फायरस्टोर ऑफ़लाइन डेटा दृढ़ता का समर्थन करता है। यह सुविधा क्लाउड फायरस्टोर डेटा की एक कॉपी को कैश करती है जिसे आपका ऐप सक्रिय रूप से उपयोग कर रहा है, इसलिए आपका ऐप डिवाइस के ऑफ़लाइन होने पर डेटा तक पहुंच सकता है। आप कैश्ड डेटा को लिख सकते हैं, पढ़ सकते हैं, सुन सकते हैं और क्वेरी कर सकते हैं। जब डिवाइस ऑनलाइन वापस आता है, तो क्लाउड फायरस्टोर आपके ऐप द्वारा किए गए किसी भी स्थानीय परिवर्तन को क्लाउड फायरस्टोर बैकएंड में सिंक्रनाइज़ करता है।

ऑफ़लाइन दृढ़ता का उपयोग करने के लिए, आपको उस कोड में कोई परिवर्तन करने की आवश्यकता नहीं है जिसका उपयोग आप Cloud Firestore डेटा तक पहुँचने के लिए करते हैं। ऑफ़लाइन दृढ़ता सक्षम होने के साथ, क्लाउड फायरस्टोर क्लाइंट लाइब्रेरी स्वचालित रूप से ऑनलाइन और ऑफलाइन डेटा एक्सेस का प्रबंधन करती है और डिवाइस के वापस ऑनलाइन होने पर स्थानीय डेटा को सिंक्रनाइज़ करती है।

ऑफ़लाइन दृढ़ता कॉन्फ़िगर करें

जब आप Cloud Firestore को प्रारंभ करते हैं, तो आप ऑफ़लाइन दृढ़ता को सक्षम या अक्षम कर सकते हैं:

  • Android और Apple प्लेटफ़ॉर्म के लिए, ऑफ़लाइन दृढ़ता डिफ़ॉल्ट रूप से सक्षम होती है। दृढ़ता को अक्षम करने के लिए, PersistenceEnabled विकल्प को false पर सेट करें।
  • वेब के लिए, ऑफ़लाइन दृढ़ता डिफ़ॉल्ट रूप से अक्षम है। दृढ़ता को सक्षम करने के लिए, enablePersistence विधि को कॉल करें। क्लाउड फायरस्टोर का कैश सत्रों के बीच स्वचालित रूप से साफ़ नहीं होता है। नतीजतन, यदि आपका वेब ऐप संवेदनशील जानकारी को संभालता है, तो दृढ़ता को सक्षम करने से पहले उपयोगकर्ता से पूछना सुनिश्चित करें कि क्या वे विश्वसनीय डिवाइस पर हैं।

Web version 9

import { enableIndexedDbPersistence } from "firebase/firestore"; 

enableIndexedDbPersistence(db)
  .catch((err) => {
      if (err.code == 'failed-precondition') {
          // Multiple tabs open, persistence can only be enabled
          // in one tab at a a time.
          // ...
      } else if (err.code == 'unimplemented') {
          // The current browser does not support all of the
          // features required to enable persistence
          // ...
      }
  });
// Subsequent queries will use persistence, if it was enabled successfully

Web version 8

firebase.firestore().enablePersistence()
  .catch((err) => {
      if (err.code == 'failed-precondition') {
          // Multiple tabs open, persistence can only be enabled
          // in one tab at a a time.
          // ...
      } else if (err.code == 'unimplemented') {
          // The current browser does not support all of the
          // features required to enable persistence
          // ...
      }
  });
// Subsequent queries will use persistence, if it was enabled successfully
तीव्र
नोट: यह उत्पाद watchOS और ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
let settings = FirestoreSettings()
settings.isPersistenceEnabled = true

// Any additional options
// ...

// Enable offline data persistence
let db = Firestore.firestore()
db.settings = settings
उद्देश्य सी
नोट: यह उत्पाद watchOS और ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
FIRFirestoreSettings *settings = [[FIRFirestoreSettings alloc] init];
settings.persistenceEnabled = YES;

// Any additional options
// ...

// Enable offline data persistence
FIRFirestore *db = [FIRFirestore firestore];
db.settings = settings;

Java

FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder()
        .setPersistenceEnabled(true)
        .build();
db.setFirestoreSettings(settings);

Kotlin+KTX

val settings = firestoreSettings {
    isPersistenceEnabled = true
}
db.firestoreSettings = settings

Dart

// Apple and Android
db.settings = const Settings(persistenceEnabled: true);

// Web
await db
    .enablePersistence(const PersistenceSettings(synchronizeTabs: true));

कैशे आकार कॉन्फ़िगर करें

जब दृढ़ता सक्षम होती है, तो क्लाउड फायरस्टोर बैकएंड से प्राप्त प्रत्येक दस्तावेज़ को ऑफ़लाइन एक्सेस के लिए कैश करता है। क्लाउड फायरस्टोर कैश आकार के लिए एक डिफ़ॉल्ट सीमा निर्धारित करता है। डिफ़ॉल्ट से अधिक होने के बाद, क्लाउड फायरस्टोर समय-समय पर पुराने, अप्रयुक्त दस्तावेजों को साफ करने का प्रयास करता है। आप एक भिन्न कैश आकार सीमा को कॉन्फ़िगर कर सकते हैं या क्लीन-अप प्रक्रिया को पूरी तरह अक्षम कर सकते हैं:

Web version 9

import { initializeFirestore, CACHE_SIZE_UNLIMITED } from "firebase/firestore";

const firestoreDb = initializeFirestore(app, {
  cacheSizeBytes: CACHE_SIZE_UNLIMITED
});

Web version 8

firebase.firestore().settings({
    cacheSizeBytes: firebase.firestore.CACHE_SIZE_UNLIMITED
});
तीव्र
नोट: यह उत्पाद watchOS और ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
// The default cache size threshold is 100 MB. Configure "cacheSizeBytes"
// for a different threshold (minimum 1 MB) or set to "FirestoreCacheSizeUnlimited"
// to disable clean-up.
let settings = Firestore.firestore().settings
settings.cacheSizeBytes = FirestoreCacheSizeUnlimited
Firestore.firestore().settings = settings
उद्देश्य सी
नोट: यह उत्पाद watchOS और ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
// The default cache size threshold is 100 MB. Configure "cacheSizeBytes"
// for a different threshold (minimum 1 MB) or set to "kFIRFirestoreCacheSizeUnlimited"
// to disable clean-up.
FIRFirestoreSettings *settings = [FIRFirestore firestore].settings;
settings.cacheSizeBytes = kFIRFirestoreCacheSizeUnlimited;
[FIRFirestore firestore].settings = settings;
  

Java


// The default cache size threshold is 100 MB. Configure "setCacheSizeBytes"
// for a different threshold (minimum 1 MB) or set to "CACHE_SIZE_UNLIMITED"
// to disable clean-up.
FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder()
        .setCacheSizeBytes(FirebaseFirestoreSettings.CACHE_SIZE_UNLIMITED)
        .build();
db.setFirestoreSettings(settings);

Kotlin+KTX


// The default cache size threshold is 100 MB. Configure "setCacheSizeBytes"
// for a different threshold (minimum 1 MB) or set to "CACHE_SIZE_UNLIMITED"
// to disable clean-up.
val settings = FirebaseFirestoreSettings.Builder()
        .setCacheSizeBytes(FirebaseFirestoreSettings.CACHE_SIZE_UNLIMITED)
        .build()
db.firestoreSettings = settings

Dart

db.settings = const Settings(
  persistenceEnabled: true,
  cacheSizeBytes: Settings.CACHE_SIZE_UNLIMITED,
);

ऑफ़लाइन डेटा सुनें

डिवाइस के ऑफ़लाइन होने पर, यदि आपने ऑफ़लाइन दृढ़ता को सक्षम किया है, तो स्थानीय रूप से संचित डेटा में परिवर्तन होने पर आपके श्रोताओं को सुनने की घटनाएं प्राप्त होंगी। आप दस्तावेज़ों, संग्रहों और प्रश्नों को सुन सकते हैं।

यह जांचने के लिए कि आप सर्वर से डेटा प्राप्त कर रहे हैं या कैशे, अपने स्नैपशॉट इवेंट में SnapshotMetadata fromCache पर कैश से संपत्ति का उपयोग करें। यदि fromCache से true , तो डेटा कैश से आया है और पुराना या अधूरा हो सकता है। यदि fromCache से false है, तो सर्वर पर नवीनतम अपडेट के साथ डेटा पूर्ण और चालू है।

डिफ़ॉल्ट रूप से, केवल SnapshotMetadata परिवर्तित होने पर कोई ईवेंट नहीं उठाया जाता है। यदि आप fromCache से मूल्यों पर भरोसा करते हैं, तो अपने श्रोता हैंडलर को संलग्न करते समय शामिल करें includeMetadataChanges सुनें विकल्प निर्दिष्ट करें।

Web version 9

import { collection, onSnapshot, where, query } from "firebase/firestore"; 

const q = query(collection(db, "cities"), where("state", "==", "CA"));
onSnapshot(q, { includeMetadataChanges: true }, (snapshot) => {
    snapshot.docChanges().forEach((change) => {
        if (change.type === "added") {
            console.log("New city: ", change.doc.data());
        }

        const source = snapshot.metadata.fromCache ? "local cache" : "server";
        console.log("Data came from " + source);
    });
});

Web version 8

db.collection("cities").where("state", "==", "CA")
  .onSnapshot({ includeMetadataChanges: true }, (snapshot) => {
      snapshot.docChanges().forEach((change) => {
          if (change.type === "added") {
              console.log("New city: ", change.doc.data());
          }

          var source = snapshot.metadata.fromCache ? "local cache" : "server";
          console.log("Data came from " + source);
      });
  });
तीव्र
नोट: यह उत्पाद watchOS और ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
// Listen to metadata updates to receive a server snapshot even if
// the data is the same as the cached data.
db.collection("cities").whereField("state", isEqualTo: "CA")
    .addSnapshotListener(includeMetadataChanges: true) { querySnapshot, error in
        guard let snapshot = querySnapshot else {
            print("Error retreiving snapshot: \(error!)")
            return
        }

        for diff in snapshot.documentChanges {
            if diff.type == .added {
                print("New city: \(diff.document.data())")
            }
        }

        let source = snapshot.metadata.isFromCache ? "local cache" : "server"
        print("Metadata: Data fetched from \(source)")
}
उद्देश्य सी
नोट: यह उत्पाद watchOS और ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
// Listen to metadata updates to receive a server snapshot even if
// the data is the same as the cached data.
[[[db collectionWithPath:@"cities"] queryWhereField:@"state" isEqualTo:@"CA"]
    addSnapshotListenerWithIncludeMetadataChanges:YES
    listener:^(FIRQuerySnapshot *snapshot, NSError *error) {
      if (snapshot == nil) {
        NSLog(@"Error retreiving snapshot: %@", error);
        return;
      }
      for (FIRDocumentChange *diff in snapshot.documentChanges) {
        if (diff.type == FIRDocumentChangeTypeAdded) {
          NSLog(@"New city: %@", diff.document.data);
        }
      }

      NSString *source = snapshot.metadata.isFromCache ? @"local cache" : @"server";
      NSLog(@"Metadata: Data fetched from %@", source);
    }];

Java

db.collection("cities").whereEqualTo("state", "CA")
        .addSnapshotListener(MetadataChanges.INCLUDE, new EventListener<QuerySnapshot>() {
            @Override
            public void onEvent(@Nullable QuerySnapshot querySnapshot,
                                @Nullable FirebaseFirestoreException e) {
                if (e != null) {
                    Log.w(TAG, "Listen error", e);
                    return;
                }

                for (DocumentChange change : querySnapshot.getDocumentChanges()) {
                    if (change.getType() == Type.ADDED) {
                        Log.d(TAG, "New city:" + change.getDocument().getData());
                    }

                    String source = querySnapshot.getMetadata().isFromCache() ?
                            "local cache" : "server";
                    Log.d(TAG, "Data fetched from " + source);
                }

            }
        });

Kotlin+KTX

db.collection("cities").whereEqualTo("state", "CA")
        .addSnapshotListener(MetadataChanges.INCLUDE) { querySnapshot, e ->
            if (e != null) {
                Log.w(TAG, "Listen error", e)
                return@addSnapshotListener
            }

            for (change in querySnapshot!!.documentChanges) {
                if (change.type == DocumentChange.Type.ADDED) {
                    Log.d(TAG, "New city: ${change.document.data}")
                }

                val source = if (querySnapshot.metadata.isFromCache)
                    "local cache"
                else
                    "server"
                Log.d(TAG, "Data fetched from $source")
            }
        }

Dart

db
    .collection("cities")
    .where("state", isEqualTo: "CA")
    .snapshots(includeMetadataChanges: true)
    .listen((querySnapshot) {
  for (var change in querySnapshot.docChanges) {
    if (change.type == DocumentChangeType.added) {
      final source =
          (querySnapshot.metadata.isFromCache) ? "local cache" : "server";

      print("Data fetched from $source}");
    }
  }
});

ऑफ़लाइन डेटा प्राप्त करें

यदि डिवाइस के ऑफ़लाइन होने पर आपको कोई दस्तावेज़ मिलता है, तो Cloud Firestore कैश से डेटा लौटाता है।

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

ऑफ़लाइन डेटा क्वेरी करें

क्वेरी ऑफ़लाइन दृढ़ता के साथ काम करती है। जैसा कि पिछले अनुभागों में बताया गया है, आप सीधे प्राप्त या सुनकर प्रश्नों के परिणामों को पुनः प्राप्त कर सकते हैं। डिवाइस के ऑफ़लाइन होने पर आप स्थानीय रूप से बने रहने वाले डेटा पर नई क्वेरी भी बना सकते हैं, लेकिन क्वेरी शुरू में केवल कैश्ड दस्तावेज़ों के विरुद्ध चलेंगी।

नेटवर्क एक्सेस को अक्षम और सक्षम करें

आप अपने क्लाउड फायरस्टोर क्लाइंट के लिए नेटवर्क एक्सेस को अक्षम करने के लिए नीचे दी गई विधि का उपयोग कर सकते हैं। जबकि नेटवर्क एक्सेस अक्षम है, सभी स्नैपशॉट श्रोता और दस्तावेज़ अनुरोध कैश से परिणाम पुनर्प्राप्त करते हैं। नेटवर्क पहुंच पुन: सक्षम होने तक लेखन कार्य कतारबद्ध हैं।

Web version 9

import { disableNetwork } from "firebase/firestore"; 

await disableNetwork(db);
console.log("Network disabled!");
// Do offline actions
// ...

Web version 8

firebase.firestore().disableNetwork()
    .then(() => {
        // Do offline actions
        // ...
    });
तीव्र
नोट: यह उत्पाद watchOS और ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
Firestore.firestore().disableNetwork { (error) in
    // Do offline things
    // ...
}
उद्देश्य सी
नोट: यह उत्पाद watchOS और ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
[[FIRFirestore firestore] disableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do offline actions
  // ...
}];

Java

db.disableNetwork()
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
                // Do offline things
                // ...
            }
        });

Kotlin+KTX

db.disableNetwork().addOnCompleteListener {
    // Do offline things
    // ...
}

Dart

db.disableNetwork().then((_) {
  // Do offline things
});

नेटवर्क पहुंच को पुन: सक्षम करने के लिए निम्न विधि का उपयोग करें:

Web version 9

import { enableNetwork } from "firebase/firestore"; 

await enableNetwork(db);
// Do online actions
// ...

Web version 8

firebase.firestore().enableNetwork()
    .then(() => {
        // Do online actions
        // ...
    });
तीव्र
नोट: यह उत्पाद watchOS और ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
Firestore.firestore().enableNetwork { (error) in
    // Do online things
    // ...
}
उद्देश्य सी
नोट: यह उत्पाद watchOS और ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
[[FIRFirestore firestore] enableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do online actions
  // ...
}];

Java

db.enableNetwork()
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
                // Do online things
                // ...
            }
        });

Kotlin+KTX

db.enableNetwork().addOnCompleteListener {
    // Do online things
    // ...
}

Dart

db.enableNetwork().then((_) {
  // Back online
});