Ative os dados offline

Ative os dados offline

O Firestore suporta a persistência de dados offline. Esta funcionalidade armazena em cache uma cópia dos dados do Firestore que a sua app está a usar ativamente, para que a app possa aceder aos dados quando o dispositivo estiver offline. Pode escrever, ler, ouvir e consultar os dados em cache.

Quando o dispositivo voltar a ficar online, o Firestore sincroniza todas as alterações locais feitas pela sua app com o backend do Firestore. Para várias alterações ao mesmo documento, a última gravação é a que prevalece.

Nota: a persistência offline só é suportada em apps Android, Apple e Web.

Para usar a persistência offline, não precisa de fazer alterações ao código que usa para aceder aos dados do Firestore. Com a persistência offline ativada, a biblioteca do cliente do Firestore gere automaticamente o acesso aos dados online e offline e sincroniza os dados locais quando o dispositivo volta a ficar online.

Configure a persistência offline

Quando inicializa o Firestore, pode ativar ou desativar a persistência offline:

• Para as plataformas Android e Apple, a persistência offline está ativada por predefinição. Para desativar a persistência, defina a opção PersistenceEnabled como false.
• Para a Web, a persistência offline está desativada por predefinição. Para ativar a persistência, chame o método enablePersistence. A cache do Firestore não é limpa automaticamente entre sessões. Consequentemente, se a sua app Web processar informações confidenciais, certifique-se de que pergunta ao utilizador se está num dispositivo fidedigno antes de ativar a persistência.

Importante: para a Web, a persistência offline só é suportada pelos navegadores de Internet Chrome, Safari e Firefox.

Versão Web 9

Saiba mais sobre o SDK modular Web v9 com eliminação de código não usado e atualize a partir da versão 8.

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

Versão Web 8

Saiba mais sobre o SDK modular Web v9 com eliminação de código não usado e atualize a partir da versão 8.

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

Nota: este produto não está disponível em alvos do watchOS e de App Clips.

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

Nota: este produto não está disponível em alvos do watchOS e de App Clips.

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
Android

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

Java
Android

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

Configure o tamanho da cache

Quando a persistência está ativada, o Firestore armazena em cache todos os documentos recebidos do back-end para acesso offline. O Firestore define um limite predefinido para o tamanho da cache. Depois de exceder o valor predefinido, o Firestore tenta periodicamente limpar documentos mais antigos e não utilizados. Pode configurar um limite de tamanho da cache diferente ou desativar completamente o processo de limpeza:

Versão Web 9

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

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

Versão Web 8

Saiba mais acerca da API Web modular com eliminação de código não usado e as respetivas vantagens em relação à API com espaço de nomes.

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

Swift

Nota: este produto não está disponível em alvos do watchOS e de App Clips.

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

Nota: este produto não está disponível em alvos do watchOS e de App Clips.

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

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

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

Ouça dados offline

Enquanto o dispositivo estiver offline, se tiver ativado a persistência offline, os seus ouvintes recebem eventos de audição quando os dados em cache localmente mudam. Pode ouvir documentos, coleções e consultas.

Para verificar se está a receber dados do servidor ou da cache, use a propriedade fromCache no SnapshotMetadata no seu evento de instantâneo. Se fromCache for true, os dados são provenientes da cache e podem estar desatualizados ou incompletos. Se fromCache for false, os dados estão completos e atualizados com as atualizações mais recentes no servidor.

Por predefinição, não é gerado nenhum evento se apenas o SnapshotMetadata tiver sido alterado. Se confiar nos valores fromCache, especifique a opção includeMetadataChanges listen quando anexar o controlador de escuta.

Versão Web 9

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

Versão Web 8

Saiba mais acerca da API Web modular com eliminação de código não usado e as respetivas vantagens em relação à API com espaço de nomes.

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

Nota: este produto não está disponível em alvos do watchOS e de App Clips.

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

Nota: este produto não está disponível em alvos do watchOS e de App Clips.

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

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
Android

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

Obtenha dados offline

Se receber um documento enquanto o dispositivo estiver offline, o Firestore devolve dados da cache.

Quando consulta uma coleção, é devolvido um resultado vazio se não existirem documentos em cache. Quando obtém um documento específico, é devolvido um erro.

Consulte dados offline

As consultas funcionam com a persistência offline. Pode obter os resultados das consultas com um pedido direto ou ouvindo, conforme descrito nas secções anteriores. Também pode criar novas consultas em dados persistentes localmente enquanto o dispositivo estiver offline, mas as consultas são inicialmente executadas apenas em relação aos documentos em cache.

Configure índices de consultas offline

Por predefinição, o SDK do Firestore analisa todos os documentos numa coleção na respetiva cache local quando executa consultas offline. Com este comportamento predefinido, o desempenho das consultas offline pode ser afetado quando os utilizadores estão offline durante longos períodos.

Com a cache persistente ativada, pode melhorar o desempenho das consultas offline permitindo que o SDK crie automaticamente índices de consultas locais.

A indexação automática está desativada por predefinição. A sua app tem de ativar a indexação automática sempre que é iniciada. Controlar se a indexação automática está ativada, conforme mostrado abaixo.

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
Android

// return type: PersistentCacheManager?

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

Java
Android

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

Assim que a indexação automática é ativada, o SDK avalia que coleções têm um grande número de documentos em cache e otimiza o desempenho das consultas locais.

O SDK fornece um método para eliminar índices de consultas.

Desative e ative o acesso à rede

Pode usar o método abaixo para desativar o acesso à rede para o seu cliente do Firestore. Quando o acesso à rede está desativado, todos os ouvintes de instantâneos e pedidos de documentos obtêm resultados da cache. As operações de escrita são colocadas em fila até o acesso à rede ser reativado.

Versão Web 9

import { disableNetwork } from "firebase/firestore"; 

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

Versão Web 8

Saiba mais acerca da API Web modular com eliminação de código não usado e as respetivas vantagens em relação à API com espaço de nomes.

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

Swift

Nota: este produto não está disponível em alvos do watchOS e de App Clips.

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

Objective-C

Nota: este produto não está disponível em alvos do watchOS e de App Clips.

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

Kotlin
Android

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

Java
Android

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

Use o seguinte método para reativar o acesso à rede:

Versão Web 9

import { enableNetwork } from "firebase/firestore"; 

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

Versão Web 8

Saiba mais acerca da API Web modular com eliminação de código não usado e as respetivas vantagens em relação à API com espaço de nomes.

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

Swift

Nota: este produto não está disponível em alvos do watchOS e de App Clips.

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

Objective-C

Nota: este produto não está disponível em alvos do watchOS e de App Clips.

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

Kotlin
Android

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

Java
Android

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