Cloud Firestore, çevrimdışı veri kalıcılığını destekler. Bu özellik, uygulamanızın aktif olarak kullandığı Cloud Firestore verilerinin bir kopyasını önbelleğe alır, böylece uygulamanız, cihaz çevrimdışıyken verilere erişebilir. Önbelleğe alınan verileri yazabilir, okuyabilir, dinleyebilir ve sorgulayabilirsiniz. Cihaz tekrar çevrimiçi olduğunda Cloud Firestore, uygulamanız tarafından yapılan tüm yerel değişiklikleri Cloud Firestore arka ucuyla senkronize eder.
Çevrimdışı kalıcılığı kullanmak için Cloud Firestore verilerine erişmek için kullandığınız kodda herhangi bir değişiklik yapmanıza gerek yoktur. Çevrimdışı kalıcılık etkinleştirildiğinde Cloud Firestore istemci kitaplığı, çevrimiçi ve çevrimdışı veri erişimini otomatik olarak yönetir ve cihaz tekrar çevrimiçi olduğunda yerel verileri senkronize eder.
Çevrimdışı kalıcılığı yapılandırma
Cloud Firestore'u başlattığınızda çevrimdışı kalıcılığı etkinleştirebilir veya devre dışı bırakabilirsiniz:
- Android ve Apple platformları için çevrimdışı kalıcılık varsayılan olarak etkindir. Kalıcılığı devre dışı bırakmak için
PersistenceEnabled
seçeneğinifalse
olarak ayarlayın. - Web için çevrimdışı kalıcılık varsayılan olarak devre dışıdır. Kalıcılığı etkinleştirmek için
enablePersistence
yöntemini çağırın. Cloud Firestore'un önbelleği oturumlar arasında otomatik olarak temizlenmez. Sonuç olarak, web uygulamanız hassas bilgileri işliyorsa kalıcılığı etkinleştirmeden önce kullanıcıya güvenilir bir cihazda olup olmadığını sorduğunuzdan emin olun.
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
Süratli
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
Amaç-C
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, çevrimdışı erişim için arka uçtan alınan her belgeyi önbelleğe alır. Cloud Firestore, önbellek boyutu için varsayılan bir eşik belirler. Varsayılan değer aşıldıktan sonra Cloud Firestore düzenli olarak daha eski, kullanılmayan belgeleri temizlemeye çalışır. Farklı bir önbellek boyutu eşiği yapılandırabilir veya temizleme işlemini tamamen devre dışı bırakabilirsiniz:
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 });
Süratli
// 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
Amaç-C
// 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 dinle
Cihaz çevrimdışıyken, çevrimdışı kalıcılığı etkinleştirdiyseniz, yerel olarak önbelleğe alınan veriler değiştiğinde dinleyicileriniz dinleme olayları alacaktır. Belgeleri, koleksiyonları ve sorguları dinleyebilirsiniz.
Sunucudan mı yoksa önbellekten mi veri aldığınızı kontrol etmek için anlık görüntü olayınızdaki SnapshotMetadata
fromCache
özelliğini kullanın. fromCache
true
ise veriler önbellekten gelmiştir ve eski veya eksik olabilir. fromCache
false
ise veriler tamdır ve sunucudaki en son güncellemelerle günceldir.
Varsayılan olarak, yalnızca SnapshotMetadata
değiştiğinde hiçbir olay tetiklenmez. fromCache
değerlerine güveniyorsanız dinleme işleyicinizi eklerken includeMetadataChanges
dinleme seçeneğini belirtin.
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); }); });
Süratli
// 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)") }
Amaç-C
// 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 belge alırsanız Cloud Firestore önbellekten verileri döndürür.
Bir koleksiyon sorgulanırken, önbelleğe alınmış belge yoksa boş bir sonuç döndürülür. Belirli bir belge getirilirken bunun yerine bir hata döndürülür.
Çevrimdışı verileri sorgula
Sorgulama çevrimdışı kalıcılıkla çalışır. Önceki bölümlerde açıklandığı gibi sorguların sonuçlarını doğrudan alma veya dinleme yoluyla alabilirsiniz. Cihaz çevrimdışıyken yerel olarak kalıcı veriler üzerinde de yeni sorgular oluşturabilirsiniz, ancak sorgular başlangıçta yalnızca önbelleğe alınan belgelerde çalıştırılacaktır.
Çevrimdışı sorgu dizinlerini yapılandırma
Varsayılan olarak Firestore SDK, çevrimdışı sorguları yürütürken bir koleksiyondaki tüm belgeleri yerel önbelleğinde tarar. Bu varsayılan davranışla, kullanıcılar uzun süre çevrimdışı kaldığında çevrimdışı sorgu performansı olumsuz etkilenebilir.
Kalıcı önbellek etkinleştirildiğinde, SDK'nın yerel sorgu dizinlerini otomatik olarak oluşturmasına izin vererek çevrimdışı sorguların performansını artırabilirsiniz.
Otomatik indeksleme varsayılan olarak devre dışıdır. Uygulamanız her başlatıldığında otomatik dizine eklemeyi etkinleştirmelidir. Aşağıda gösterildiği gibi otomatik indekslemenin etkin olup olmadığını kontrol edin.
Süratli
if let indexManager = Firestore.firestore().persistentCacheIndexManager { // Indexing is disabled by default indexManager.enableIndexAutoCreation() } else { print("indexManager is nil") }
Amaç-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 indeksleme etkinleştirildiğinde SDK, hangi koleksiyonların çok sayıda önbelleğe alınmış belgeye sahip olduğunu değerlendirir 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ırakın ve etkinleştirin
Cloud Firestore istemcinizin ağ erişimini devre dışı bırakmak için aşağıdaki yöntemi kullanabilirsiniz. Ağ erişimi devre dışı bırakıldığında, tüm anlık görüntü dinleyicileri ve belge istekleri, sonuçları önbellekten alır. Ağ erişimi yeniden etkinleştirilene kadar yazma işlemleri sıraya alınır.
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 // ... });
Süratli
Firestore.firestore().disableNetwork { (error) in // Do offline things // ... }
Amaç-C
[[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 modular API
import { enableNetwork } from "firebase/firestore"; await enableNetwork(db); // Do online actions // ...
Web namespaced API
firebase.firestore().enableNetwork() .then(() => { // Do online actions // ... });
Süratli
Firestore.firestore().enableNetwork { (error) in // Do online things // ... }
Amaç-C
[[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 });