Acessar dados off-line

O Cloud Firestore é compatível com a permanência de dados off-line. Este recurso armazena em cache uma cópia dos dados do Cloud Firestore que seu app usa ativamente. Assim, o app pode acessar os dados quando o dispositivo estiver desconectado. É possível gravar, ler, detectar e consultar os dados armazenados em cache. Quando o dispositivo é conectado novamente, o Cloud Firestore sincroniza todas as alterações locais feitas pelo app no back-end do Cloud Firestore.

Para usar a permanência off-line, não é necessário alterar o código que você usa para acessar dados do Cloud Firestore. Com a permanência off-line ativada, a biblioteca de cliente do Cloud Firestore gerencia automaticamente o acesso a dados on-line e off-line e sincroniza os dados locais quando o dispositivo é conectado novamente.

Configurar a permanência off-line

Quando você inicializa o Cloud Firestore, é possível ativar ou desativar a permanência off-line como nos casos a seguir:

Para Android e plataformas da Apple, a permanência off-line está ativada por padrão. Para desativar a permanência, defina a opção PersistenceEnabled como false.
Para a Web, a permanência off-line está desativada por padrão. Para ativar a permanência, chame o método enablePersistence. O cache do Cloud Firestore não é esvaziado automaticamente entre as sessões. Consequentemente, se o app da Web lidar com informações confidenciais, antes de ativar a permanência, pergunte ao usuário se ele está em um dispositivo confiável.

Web version 9

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

Swift

Observação: esse produto não está disponível para destinos watchOS e de clipes de apps.

let settings = FirestoreSettings()
settings.isPersistenceEnabled = true

// Any additional options
// ...

// Enable offline data persistence
let db = Firestore.firestore()
db.settings = settingsViewController.swift

Objective-C

Observação: esse produto não está disponível para destinos watchOS e de clipes de apps.

FIRFirestoreSettings *settings = [[FIRFirestoreSettings alloc] init];
settings.persistenceEnabled = YES;

// Any additional options
// ...

// Enable offline data persistence
FIRFirestore *db = [FIRFirestore firestore];
db.settings = settings;ViewController.m

Kotlin+KTX

val settings = firestoreSettings {
    isPersistenceEnabled = true
}
db.firestoreSettings = settingsDocSnippets.kt

Java

FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder()
        .setPersistenceEnabled(true)
        .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

Configurar o tamanho do cache

Quando a permanência é ativada, o Cloud Firestore armazena em cache todos os documentos recebidos do back-end para acesso off-line. O Cloud Firestore define um limite padrão para o tamanho do cache. Depois de exceder esse valor, o Cloud Firestore tenta remover periodicamente documentos antigos e não usados. É possível configurar outro limite de tamanho de cache ou desativar completamente o processo de limpeza:

Web version 9

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

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

Web version 8

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

Swift

Observação: esse produto não está disponível para destinos watchOS e de clipes de apps.

// 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
settings.cacheSizeBytes = FirestoreCacheSizeUnlimited
Firestore.firestore().settings = settingsViewController.swift

Objective-C

Observação: esse produto não está disponível para destinos watchOS e de clipes de apps.

// 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;
settings.cacheSizeBytes = kFIRFirestoreCacheSizeUnlimited;
[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

Detectar dados off-line

Enquanto o dispositivo estiver desconectado, se você tiver ativado a permanência off-line, seus listeners receberão eventos de detecção quando os dados armazenados em cache local forem alterados. É possível detectar documentos, coleções e consultas.

Para verificar se você está recebendo dados do servidor ou do cache, use a propriedade fromCache no SnapshotMetadata no seu evento de snapshot. Se fromCache for true, os dados vieram do cache e podem estar desatualizados ou incompletos. Se fromCache for false, os dados estão completos, atualizados com as atualizações mais recentes no servidor.

Por padrão, nenhum evento será gerado se somente o SnapshotMetadata for alterado. Se você depender dos valores fromCache, especifique a opção de detecção includeMetadataChanges quando anexar seu gerenciador de detecção.

Web version 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

Web version 8

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

Observação: esse produto não está disponível para destinos watchOS e de clipes de apps.

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

Observação: esse produto não está disponível para destinos watchOS e de clipes de apps.

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

Receber dados off-line

Se você receber um documento enquanto o dispositivo estiver desconectado, o Cloud Firestore retornará os dados do cache.

Quando estiver consultando uma coleção, um resultado vazio será retornado se não houver documentos armazenados em cache. Quando estiver buscando um documento específico, um erro será retornado.

Consultar dados off-line

As consultas funcionam com a permanência off-line. É possível recuperar os resultados das consultas por meio de recebimentos diretos e por detecção, conforme descrito nas seções anteriores. Também é possível criar novas consultas em dados com permanência local enquanto o dispositivo estiver off-line. Porém, a princípio, elas serão executadas apenas nos documentos armazenados em cache.

Configurar índices de consulta off-line

Por padrão, o SDK do Firestore verifica todos os documentos em uma coleção no cache local ao executar consultas off-line. Com esse comportamento padrão, o desempenho das consultas off-line pode ser afetado quando os usuários ficam off-line por longos períodos.

É possível melhorar o desempenho das consultas off-line configurando os índices de consulta local:

Swift

O SDK para a plataforma Apple oferece um método setIndexConfiguration que lê a mesma configuração estruturada em JSON usada para configurar índices no servidor, seguindo o mesmo formato de definição de índice.

// You will normally read this from a file asset or cloud storage.
let indexConfigJson = """
  {
    indexes: [
        ...
    ],
    fieldOverrides: [
        ...
    ]
  }
"""

// Apply the configuration.
Firestore.firestore().setIndexConfiguration(indexConfigJson)

Objective-C

O SDK para a plataforma Apple oferece métodos setIndexConfiguration- que leem a mesma configuração estruturada em JSON usada para configurar índices no servidor, seguindo o mesmo formato de definição de índice.

// You will normally read this from a file asset or cloud storage.
NSString *indexConfigJson = @" {                   "
                             "   indexes: [        "
                             "     ...             "
                             "   ],                "
                             "   fieldOverrides: [ "
                             "     ...             "
                             "   ]                 "
                             " }                   ";

// Apply the configuration.
[[FIRFirestore firestore] setIndexConfigurationFromJSON:indexConfigJson
                                             completion:^(NSError * _Nullable error) {
    // ...
}];

Java

O SDK do Android fornece um método setIndexConfiguration que lê a mesma configuração estruturada em JSON usada para configurar índices no servidor, seguindo o mesmo formato de definição de índice.

// You will normally read this from a file asset or cloud storage.
String indexConfigJson = " {                   "
                       + "   indexes: [        "
                       + "     ...             "
                       + "   ],                "
                       + "   fieldOverrides: [ "
                       + "     ...             "
                       + "   ]                 "
                       + " }                   ";
// Apply the configuration.
FirebaseFirestore.getInstance().setIndexConfiguration(indexConfigJson);

Kotlin+KTX

// You will normally read this from a file asset or cloud storage.
val indexConfigJson = """
{
  indexes: [
      ...
  ],
  fieldOverrides: [
      ...
  ]
}
"""

// Apply the configuration.
FirebaseFirestore.getInstance().setIndexConfiguration(indexConfigJson)

Dart

O SDK do Flutter fornece um método setIndexConfigurationFromJSON que lê a mesma configuração estruturada em JSON usada para configurar índices no servidor, seguindo o mesmo formato de definição de índice.

// You will normally read this from a file asset or cloud storage.
var indexConfigJson = """
{
  indexes: [
      ...
  ],
  fieldOverrides: [
      ...
  ]
}
""";

// Apply the configuration.
await FirebaseFirestore.instance.setIndexConfigurationFromJSON(json: indexConfigJson);

Também é possível usar o método setIndexConfiguration para configurar índices com uma API baseada em classes.

var indexes = [
  Index(
    collectionGroup: "posts",
    queryScope: QueryScope.collection,
    fields: [
      IndexField(fieldPath: "author", arrayConfig: ArrayConfig.contains),
      IndexField(fieldPath: "timestamp", order: Order.descending)
    ],
  ),
];
await FirebaseFirestore.instance.setIndexConfiguration(indexes: indexes);

A configuração do índice off-line que vai ser usada depende das coleções e dos documentos que seu app acessa intensamente enquanto está off-line e do desempenho off-line que você quer. Embora seja possível exportar a configuração do índice de back-end para usar no cliente, os padrões de acesso off-line do app provavelmente são diferentes dos padrões de acesso on-line. Portanto, a configuração do índice on-line não é adequada para uso off-line. Quais coleções e documentos você quer que seu app acesse off-line com alto desempenho? Depois de analisar o comportamento do app, siga os princípios de definição de índice do guia de indexação.

Para disponibilizar configurações de índice off-line para carregamento no app cliente, faça o seguinte:

Compile e distribua as configurações no seu app.
Faça o download delas em uma CDN.
Busque as configurações em um sistema de armazenamento, como o Cloud Storage para Firebase.

Desativar e ativar o acesso à rede

Use o método abaixo para desativar o acesso à rede no cliente do Cloud Firestore. Enquanto o acesso à rede estiver desativado, todos os listeners de snapshots e solicitações de documentos recuperarão os resultados do cache. As operações de gravação serão enfileiradas até que o acesso à rede seja reativado.

Web version 9

import { disableNetwork } from "firebase/firestore";

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

Web version 8

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

Swift

Observação: esse produto não está disponível para destinos watchOS e de clipes de apps.

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

Objective-C

Observação: esse produto não está disponível para destinos watchOS e de clipes de apps.

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

Use o método a seguir para reativar o acesso à rede:

Web version 9

import { enableNetwork } from "firebase/firestore";

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

Web version 8

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

Swift

Observação: esse produto não está disponível para destinos watchOS e de clipes de apps.

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

Objective-C

Observação: esse produto não está disponível para destinos watchOS e de clipes de apps.

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