Verilere çevrimdışı olarak erişme

Cloud Firestore, çevrimdışı veri kalıcılığını destekler. Bu özellik bir kopyayı önbelleğe alır uygulamanızın etkin olarak kullandığı Cloud Firestore verilerinin oranı, yani cihaz çevrimdışıyken verilere erişebilir. Metin yazabilir, okuyabilir, dinleyebilir, ve önbelleğe alınan verileri sorgulayabilir. Cihaz tekrar internete bağlandığında Cloud Firestore, uygulamanız tarafından yapılan tüm yerel değişiklikleri Cloud Firestore arka ucu.

Çevrimdışı kalıcılığı kullanmak için gereken kodda herhangi bir değişiklik Cloud Firestore verilerine erişmek için kullanacağınız araçlardır. Çevrimdışı kalıcılık etkinleştirildiğinde, Cloud Firestore istemci kitaplığı, online ve çevrimdışı işlemleri otomatik olarak yönetir. çevrimdışı veri erişimi sağlar ve cihaz tekrar çevrimiçi olduğunda yerel verileri senkronize eder.

Çevrimdışı kalıcılığı yapılandırma

Cloud Firestore uygulamasını ilk kullanıma hazırlarken etkinleştirebilir veya devre dışı bırakabilirsiniz çevrimdışı kalıcılık:

  • Çevrimdışı kalıcılık, Android ve Apple platformlarında varsayılan olarak etkindir. Devre dışı bırakmak için kalıcılık için PersistenceEnabled seçeneğini false olarak ayarlayın.
  • Web için çevrimdışı kalıcılık varsayılan olarak devre dışıdır. Etkinleştirmek için devamlılık varsa enablePersistence yöntemini çağırın. Cloud Firestore adlı cihazın önbelleği oturumları arasında otomatik olarak temizlenmez. Sonuç olarak, web uygulamanız Hassas bilgileri işliyorsa kullanıcıya onun güvenilir bir emin olun.
ziyaret edin.

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 successfully
Swift
Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz.
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
Objective-C
Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz.
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));

Önbellek boyutunu yapılandırın

Kalıcılık etkinleştirildiğinde Cloud Firestore her dokümanı önbelleğe alır çevrimdışı erişim için arka uçtan alınır. Cloud Firestore, bir varsayılan eşiktir. Varsayılan değer aşıldıktan sonra, Cloud Firestore düzenli olarak eski ve kullanılmayan yerleri temizlemeye çalışır yardımcı olur. Farklı bir önbellek boyutu eşiği yapılandırabilirsiniz veya temizleme işlemini tamamen devre dışı bırakın:

Web

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

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

Web

firebase.firestore().settings({
    cacheSizeBytes: firebase.firestore.CACHE_SIZE_UNLIMITED
});
Swift
Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz.
// 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
Objective-C
Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz.
// 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,
);

Çevrimdışı verileri dinleme

Cihaz çevrimdışıyken, çevrimdışı kalıcılığı etkinleştirdiyseniz dinleyiciler, yerel olarak önbelleğe alınmış veriler değiştiğinde dinleme etkinlikleri alır. Siz dokümanları, koleksiyonları ve sorguları dinleyebilir.

Sunucudan mı yoksa önbellekten mi veri aldığınızı kontrol etmek için fromCache özelliği, anlık görüntü etkinliğinizde SnapshotMetadata üzerinde. Eğer fromCache parametresi true. Veriler önbellekten alındı ve eski veya eski olabilir. tamamlanmadı. fromCache değeri false ise veriler sunucudaki son güncellemelerden biri.

Varsayılan olarak, yalnızca SnapshotMetadata değiştiyse hiçbir etkinlik oluşturulmaz. Şu durumda: fromCache değerlerini temel alıyorsa includeMetadataChanges dinlemesini belirtin seçeneği sunar.

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

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);
      });
  });
Swift
Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz.
// 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)")
  }
Objective-C
Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz.
// 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}");
    }
  }
});

Çevrimdışı verileri alın

Cihaz çevrimdışıyken bir doküman alırsanız Cloud Firestore önbellekten veri döndürür.

Bir koleksiyon sorgulanırken önbelleğe alınmış bir sonuç yoksa boş sonuç döndürülür yardımcı olur. Belirli bir doküman getirilirken hata döndürülür.

Çevrimdışı verileri sorgulama

Sorgulama, çevrimdışı kalıcılıkla çalışır. Sorguların sonuçlarını yukarıda açıklandığı gibi, doğrudan elde ederek veya dinleyerek bölümlerini kontrol edin. Ayrıca, cihaz çevrimdışı, ancak sorgular başlangıçta yalnızca önbelleğe alınmış cihaz üzerinde çalışacak yardımcı olur.

Çevrimdışı sorgu dizinlerini yapılandırın

Varsayılan olarak Firestore SDK'sı bir koleksiyondaki tüm dokümanları tarar. yerel önbelleğin kullanılmasına dikkat edin. Bu varsayılan davranışla, çevrimdışı Kullanıcılar uzun süre çevrimdışı olduğunda sorgu performansı düşebilir.

Kalıcı önbelleği etkinleştirerek çevrimdışı ortamdaki SDK'nın yerel sorgu dizinlerini otomatik olarak oluşturmasına izin vererek.

Otomatik dizine ekleme varsayılan olarak devre dışıdır. Uygulamanız şunları etkinleştirmelidir: her başlatıldığında otomatik olarak dizine eklenir. Otomatik dizine eklemenin aşağıda gösterildiği gibi etkinleştirilir.

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

Otomatik dizine ekleme etkinleştirildikten sonra, SDK hangi koleksiyonların önbelleğe alınmış çok sayıda doküman içerir ve yerel sorguların performansını optimize eder.

SDK, sorgu dizinlerini silmek için bir yöntem sağlar.

Ağ erişimini devre dışı bırakma ve etkinleştirme

Cloud Firestore istemci. Ağ erişimi devre dışı bırakıldığında, tüm anlık görüntüler işleyiciler ve belge istekleri, sonuçları önbellekten alır. Yazı yazma işlemleri, ağ erişimi yeniden etkinleştirilene kadar sıraya alınır.

Web

import { disableNetwork } from "firebase/firestore"; 

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

Web

firebase.firestore().disableNetwork()
    .then(() => {
        // Do offline actions
        // ...
    });
Swift
Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz.
Firestore.firestore().disableNetwork { (error) in
  // Do offline things
  // ...
}
Objective-C
Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz.
[[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
});

Ağ erişimini yeniden etkinleştirmek için aşağıdaki yöntemi kullanın:

Web

import { enableNetwork } from "firebase/firestore"; 

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

Web

firebase.firestore().enableNetwork()
    .then(() => {
        // Do online actions
        // ...
    });
Swift
Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz.
Firestore.firestore().enableNetwork { (error) in
  // Do online things
  // ...
}
Objective-C
Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz.
[[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
});