Verilere çevrimdışı olarak erişme

Cloud Firestore, çevrimdışı veri kalıcılığını destekler. Bu özellik, uygulamanızın etkin olarak kullandığı Cloud Firestore verilerinin bir kopyasını önbelleğe alır. Böylece uygulamanız, cihaz çevrimdışı olduğunda verilere erişebilir. Önbelleğe alınan verileri yazabilir, okuyabilir, dinleyebilir ve sorgulayabilirsiniz. Cihaz tekrar internete bağlandığında, Cloud Firestore uygulamanızın yaptığı yerel değişiklikleri Cloud Firestore arka ucuyla senkronize eder.

Not: Çevrimdışı kalıcılık yalnızca Android, Apple ve web uygulamalarında desteklenir.

Çevrimdışı kalıcılığı kullanmak için Cloud Firestore verilerine erişmek üzere kullandığınız kodda herhangi bir değişiklik yapmanız gerekmez. Çevrimdışı kalıcılık etkinleştirildiğinde Cloud Firestore istemci kitaplığı, online ve çevrimdışı veri erişimini otomatik olarak yönetir ve cihaz tekrar internete bağlandığında yerel verileri senkronize eder.

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

Cloud Firestore'ı başlattığınızda çevrimdışı kalıcılığı etkinleştirebilir veya devre dışı bırakabilirsiniz:

• Android ve Apple platformlarında çevrimdışı kalıcılık varsayılan olarak etkindir. Kalıcılığı devre dışı bırakmak için PersistenceEnabled seçeneğini false olarak ayarlayın.
• Web için çevrimdışı kalıcılık özelliği varsayılan olarak devre dışıdır. Kalıcılığı etkinleştirmek için enablePersistence yöntemini çağırın. Cloud Firestore'nın önbelleği oturumlar arasında otomatik olarak temizlenmez. Bu nedenle, web uygulamanız hassas bilgileri işliyorsa kalıcılığı etkinleştirmeden önce kullanıcıya güvenilir bir cihazda olup olmadığını sorun.

Önemli: Web'de çevrimdışı kalıcılık yalnızca Chrome, Safari ve Firefox web tarayıcılarında desteklenir.

Web

Ağaç yapısı oluşturulabilen Web v9 modüler SDK'sı hakkında daha fazla bilgi edinin ve 8. sürümden yükseltme yapın.

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

Ağaç yapısı oluşturulabilen Web v9 modüler SDK'sı hakkında daha fazla bilgi edinin ve 8. sürümden yükseltme yapın.

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

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
ViewController.swift

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

Kotlin

val settings = firestoreSettings {
    // Use memory cache
    setLocalCacheSettings(memoryCacheSettings {})
    // Use persistent disk cache (default)
    setLocalCacheSettings(persistentCacheSettings {})
}
db.firestoreSettings = settings
DocSnippets.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

Önbellek boyutunu yapılandırma

Kalıcılık etkinleştirildiğinde Cloud Firestore, çevrimdışı erişim için arka uçtan alınan her dokümanı önbelleğe alır. Cloud Firestore önbellek boyutu için varsayılan bir eşik belirler. Varsayılan sınır aşıldıktan sonra Cloud Firestore, eski ve kullanılmayan belgeleri düzenli olarak temizlemeye çalışır. Farklı bir önbellek boyutu eşiği yapılandırabilir veya temizleme sürecini tamamen devre dışı bırakabilirsiniz:

Web

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

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

Web

Ağaç yapısı oluşturulabilen modüler Web API'si ve ad alanı içeren API'ye göre avantajları hakkında daha fazla bilgi edinin.

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

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
ViewController.swift

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

Kotlin

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

Çevrimdışı verileri dinleme

Cihaz çevrimdışı durumdayken çevrimdışı kalıcılığı etkinleştirdiyseniz dinleyicileriniz, yerel olarak önbelleğe alınan veriler değiştiğinde dinleme etkinlikleri alır. Dokümanları, koleksiyonları ve sorguları dinleyebilirsiniz.

Sunucudan veya önbellekten veri alıp almadığınızı kontrol etmek için anlık görüntü etkinliğinizdeki SnapshotMetadata içinde fromCache özelliğini kullanın. fromCache true ise veriler önbellekten alınmıştır ve eski veya eksik olabilir. fromCache false ise veriler eksiksizdir ve sunucudaki en son güncellemelerle günceldir.

Varsayılan olarak, yalnızca SnapshotMetadata değiştiyse herhangi bir etkinlik oluşturulmaz. fromCache değerlerini kullanıyorsanız dinleme işleyicinizi eklerken includeMetadataChanges dinleme seçeneğini belirtin.

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

Ağaç yapısı oluşturulabilen modüler Web API'si ve ad alanı içeren API'ye göre avantajları hakkında daha fazla bilgi edinin.

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

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

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

Kotlin

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

Çevrimdışı verileri alma

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

Bir koleksiyona sorgu gönderildiğinde, önbelleğe alınmış belge yoksa boş bir sonuç döndürülür. Belirli bir doküman getirilirken bunun yerine hata döndürülür.

Çevrimdışı verileri sorgulama

Sorgulama, çevrimdışı kalıcılıkla çalışır. Sorgu sonuçlarını, önceki bölümlerde açıklandığı gibi doğrudan getirme veya dinleme yoluyla alabilirsiniz. Cihaz çevrimdışıyken yerel olarak kalıcı hale getirilmiş veriler üzerinde yeni sorgular da oluşturabilirsiniz ancak sorgular başlangıçta yalnızca önbelleğe alınmış dokümanlara karşı çalıştırılır.

Çevrimdışı sorgu dizinlerini yapılandırma

Varsayılan olarak, Firestore SDK'sı çevrimdışı sorguları yürütürken yerel önbelleğindeki bir koleksiyondaki tüm belgeleri tarar. Bu varsayılan davranış nedeniyle, kullanıcılar uzun süre çevrimdışı kaldığında çevrimdışı sorgu performansı düşebilir.

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 dizine ekleme varsayılan olarak devre dışıdır. Uygulamanız her başlatıldığında otomatik dizine eklemeyi etkinleştirmelidir. Otomatik dizine eklemenin aşağıda gösterildiği gibi etkin olup olmadığını kontrol edin.

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

// 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ştirildikten sonra SDK, hangi koleksiyonlarda çok sayıda önbelleğe alınmış doküman olduğunu değerlendirir ve yerel sorguların performansını optimize eder.

SDK, sorgu dizinlerini silmek için bir yöntem sunar.

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

Aşağıdaki yöntemi kullanarak Cloud Firestore istemciniz için ağ erişimini devre dışı bırakabilirsiniz. Ağ erişimi devre dışıyken tüm anlık görüntü dinleyicileri ve doküman istekleri sonuçları önbellekten alır. 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
// ...
disable_network.js

Web

Ağaç yapısı oluşturulabilen modüler Web API'si ve ad alanı içeren API'ye göre avantajları hakkında daha fazla bilgi edinin.

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

Swift

Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz.

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

Objective-C

Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz.

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

Kotlin

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

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
// ...
enable_network.js

Web

Ağaç yapısı oluşturulabilen modüler Web API'si ve ad alanı içeren API'ye göre avantajları hakkında daha fazla bilgi edinin.

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

Swift

Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz.

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

Objective-C

Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz.

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

Kotlin

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