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

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

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

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

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

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

Web modular API

// Memory cache is the default if no config is specified.
initializeFirestore(app);

// This is the default behavior if no persistence is specified.
initializeFirestore(app, {localCache: memoryLocalCache()});

// Defaults to single-tab persistence if no tab manager is specified.
initializeFirestore(app, {localCache: persistentLocalCache(/*settings*/{})});

// Same as `initializeFirestore(app, {localCache: persistentLocalCache(/*settings*/{})})`,
// but more explicit about tab management.
initializeFirestore(app, 
  {localCache: 
    persistentLocalCache(/*settings*/{tabManager: persistentSingleTabManager()})
});

// Use multi-tab IndexedDb persistence.
initializeFirestore(app, 
  {localCache: 
    persistentLocalCache(/*settings*/{tabManager: persistentMultipleTabManager()})
  });
  

Web namespaced API

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
तीव्र
नोट: यह उत्पाद वॉचओएस और ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
let settings = FirestoreSettings()

// Use memory-only cache
settings.cacheSettings =
MemoryCacheSettings(garbageCollectorSettings: MemoryLRUGCSettings())

// Use persistent disk cache, with 100 MB cache size
settings.cacheSettings = PersistentCacheSettings(sizeBytes: 100 * 1024 * 1024 as NSNumber)

// Any additional options
// ...

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

// Use memory-only cache
settings.cacheSettings = [[FIRMemoryCacheSettings alloc]
    initWithGarbageCollectorSettings:[[FIRMemoryLRUGCSettings alloc] init]];

// Use persistent disk cache (default behavior)
// This example uses 100 MB.
settings.cacheSettings = [[FIRPersistentCacheSettings alloc]
    initWithSizeBytes:@(100 * 1024 * 1024)];

// Any additional options
// ...

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

Kotlin+KTX

val settings = firestoreSettings {
    // Use memory cache
    setLocalCacheSettings(memoryCacheSettings {})
    // Use persistent disk cache (default)
    setLocalCacheSettings(persistentCacheSettings {})
}
db.firestoreSettings = settings

Java

FirebaseFirestoreSettings settings = 
new FirebaseFirestoreSettings.Builder(db.getFirestoreSettings())
    // Use memory-only cache
    .setLocalCacheSettings(MemoryCacheSettings.newBuilder().build())
    // Use persistent disk cache (default)
    .setLocalCacheSettings(PersistentCacheSettings.newBuilder()
                            .build())
    .build();
db.setFirestoreSettings(settings);

Dart

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

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

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

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

Web modular API

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

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

Web namespaced API

firebase.firestore().settings({
    cacheSizeBytes: firebase.firestore.CACHE_SIZE_UNLIMITED
});
तीव्र
नोट: यह उत्पाद वॉचओएस और ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
// 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
// Set cache size to 100 MB
settings.cacheSettings = PersistentCacheSettings(sizeBytes: 100 * 1024 * 1024 as NSNumber)
Firestore.firestore().settings = settings
उद्देश्य सी
नोट: यह उत्पाद वॉचओएस और ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
// 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;
// Set cache size to 100 MB
settings.cacheSettings =
    [[FIRPersistentCacheSettings alloc] initWithSizeBytes:@(100 * 1024 * 1024)];
[FIRFirestore firestore].settings = 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

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);

Dart

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

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

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

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

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

Web modular API

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 namespaced API

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);
      });
  });
तीव्र
नोट: यह उत्पाद वॉचओएस और ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
// 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)")
  }
उद्देश्य सी
नोट: यह उत्पाद वॉचओएस और ऐप क्लिप लक्ष्य पर उपलब्ध नहीं है।
// 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);
    }];

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")
        }
    }

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);
                }

            }
        });

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}");
    }
  }
});

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

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

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

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

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

ऑफ़लाइन क्वेरी अनुक्रमणिका कॉन्फ़िगर करें

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

लगातार कैश सक्षम होने पर, आप एसडीके को स्वचालित रूप से स्थानीय क्वेरी इंडेक्स बनाने की अनुमति देकर ऑफ़लाइन क्वेरी के प्रदर्शन में सुधार कर सकते हैं।

स्वचालित अनुक्रमण डिफ़ॉल्ट रूप से अक्षम है. आपके ऐप को हर बार प्रारंभ होने पर स्वचालित अनुक्रमण सक्षम करना होगा। नीचे दिखाए अनुसार नियंत्रित करें कि स्वचालित अनुक्रमण सक्षम है या नहीं।

तीव्र
if let indexManager = Firestore.firestore().persistentCacheIndexManager {
  // Indexing is disabled by default
  indexManager.enableIndexAutoCreation()
} else {
  print("indexManager is nil")
}
    
उद्देश्य सी
PersistentCacheIndexManager *indexManager = [FIRFirestore firestore].persistentCacheIndexManager;
if (indexManager) {
  // Indexing is disabled by default
  [indexManager enableIndexAutoCreation];
}
    

Kotlin+KTX

// return type: PersistentCacheManager?

Firebase.firestore.persistentCacheIndexManager?.apply {
      // Indexing is disabled by default
      enableIndexAutoCreation()
    } ?: println("indexManager is null")
    

Java

// return type: @Nullable PersistentCacheIndexManager
PersistentCacheIndexManager indexManager = FirebaseFirestore.getInstance().getPersistentCacheIndexManager();
if (indexManager != null) {
  // Indexing is disabled by default
  indexManager.enableIndexAutoCreation();
}

// If not check indexManager != null, IDE shows warning: Method invocation 'enableIndexAutoCreation' may produce 'NullPointerException' 
FirebaseFirestore.getInstance().getPersistentCacheIndexManager().enableIndexAutoCreation();
    

एक बार स्वचालित अनुक्रमण सक्षम हो जाने पर, एसडीके मूल्यांकन करता है कि किस संग्रह में बड़ी संख्या में कैश्ड दस्तावेज़ हैं और स्थानीय प्रश्नों के प्रदर्शन को अनुकूलित करता है।

एसडीके क्वेरी इंडेक्स को हटाने के लिए एक विधि प्रदान करता है।

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

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

Web modular API

import { disableNetwork } from "firebase/firestore"; 

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

Web namespaced API

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

Kotlin+KTX

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

Java

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

Dart

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

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

Web modular API

import { enableNetwork } from "firebase/firestore"; 

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

Web namespaced API

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

Kotlin+KTX

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

Java

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

Dart

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