इस पेज का अनुवाद Cloud Translation API से किया गया है.

डेटा को ऑफ़लाइन ऐक्सेस करना

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

ऑफ़लाइन परसिस्टेंस का इस्तेमाल करने के लिए, आपको उस कोड में कोई बदलाव करने की ज़रूरत नहीं है जिसका इस्तेमाल आप Cloud Firestore डेटा को ऐक्सेस करने के लिए करते हैं. ऑफ़लाइन परसिस्टेंस चालू होने पर, Cloud Firestore क्लाइंट लाइब्रेरी ऑनलाइन और ऑफ़लाइन डेटा के ऐक्सेस को अपने-आप मैनेज करती है. साथ ही, डिवाइस के वापस ऑनलाइन आने पर, लोकल डेटा को सिंक करती है.

ऑफ़लाइन पर्सेंटेंस कॉन्फ़िगर करें

Cloud Firestore को शुरू करने पर, ऑफ़लाइन परसिस्टेंस को चालू या बंद किया जा सकता है:

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

Web

// 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

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 successfullytest.firestore.js

Swift

ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.

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 = settingsViewController.swift

Objective-C

ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.

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;ViewController.m

Kotlin+KTX

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

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);DocSnippets.java

Dart

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

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

कैश मेमोरी के साइज़ को कॉन्फ़िगर करें

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

Web

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

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

Web

firebase.firestore().settings({
    cacheSizeBytes: firebase.firestore.CACHE_SIZE_UNLIMITED
});test.firestore.js

Swift

ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.

// 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 = settingsViewController.swift

Objective-C

ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.

// 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;ViewController.m

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,
);firestore.dart

ऑफ़लाइन डेटा सुनने की सुविधा

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

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

डिफ़ॉल्ट रूप से, अगर सिर्फ़ SnapshotMetadata में बदलाव हुआ है, तो कोई भी इवेंट नहीं बढ़ाया जाता. अगर आप fromCache वैल्यू का इस्तेमाल करते हैं, तो अपना लिसनर हैंडलर अटैच करते समय, includeMetadataChanges लिसनर विकल्प तय करें.

Web

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);
    });
});use_from_cache.js

Web

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);
      });
  });test.firestore.js

Swift

ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.

// 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)")
  }ViewController.swift

Objective-C

ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.

// 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);
    }];ViewController.m

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")
        }
    }DocSnippets.kt

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

            }
        });DocSnippets.java

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

ऑफ़लाइन डेटा पाएं

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

किसी कलेक्शन के लिए क्वेरी करते समय, कैश मेमोरी में सेव किया गया कोई दस्तावेज़ न होने पर, एक खाली नतीजा मिलता है. किसी खास दस्तावेज़ को फ़ेच करने के दौरान, गड़बड़ी का मैसेज दिखता है.

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

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

ऑफ़लाइन क्वेरी इंडेक्स कॉन्फ़िगर करें

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

स्थायी कैश मेमोरी की सुविधा चालू होने पर, SDK टूल को अपने-आप लोकल क्वेरी इंडेक्स बनाने की अनुमति देकर, ऑफ़लाइन क्वेरी की परफ़ॉर्मेंस को बेहतर बनाया जा सकता है.

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

Swift

if let indexManager = Firestore.firestore().persistentCacheIndexManager {
  // Indexing is disabled by default
  indexManager.enableIndexAutoCreation()
} else {
  print("indexManager is nil")
}

Objective-C

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

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

SDK टूल, क्वेरी इंडेक्स को मिटाने का तरीका उपलब्ध कराता है.

नेटवर्क ऐक्सेस बंद और चालू करें

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

Web

import { disableNetwork } from "firebase/firestore"; 

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

Web

firebase.firestore().disableNetwork()
    .then(() => {
        // Do offline actions
        // ...
    });test.firestore.js

Swift

ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.

Firestore.firestore().disableNetwork { (error) in
  // Do offline things
  // ...
}ViewController.swift

Objective-C

ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.

[[FIRFirestore firestore] disableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do offline actions
  // ...
}];ViewController.m

Kotlin+KTX

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

Java

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

Dart

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

नेटवर्क का ऐक्सेस फिर से चालू करने के लिए, नीचे दिए गए तरीके का इस्तेमाल करें:

Web

import { enableNetwork } from "firebase/firestore"; 

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

Web

firebase.firestore().enableNetwork()
    .then(() => {
        // Do online actions
        // ...
    });test.firestore.js

Swift

ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.

Firestore.firestore().enableNetwork { (error) in
  // Do online things
  // ...
}ViewController.swift

Objective-C

ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.

[[FIRFirestore firestore] enableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do online actions
  // ...
}];ViewController.m

Kotlin+KTX

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

Java

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

Dart

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