Cette page a été traduite par l'API Cloud Translation.

Utiliser l'émulateur Firestore en local

La Google Cloud CLI fournit un émulateur local en mémoire pour Firestore pour tester votre application. Vous pouvez utiliser avec toutes les bibliothèques clientes Firestore. Vous devez utiliser l'émulateur uniquement pour les tests locaux.

N'utilisez pas l'émulateur pour les déploiements de production. Comme l'émulateur stocke les données uniquement en mémoire, les données ne seront pas conservées d'une exécution à l'autre.

Installer l'émulateur

Pour installer l'émulateur Firestore, installez et mettez à jour le fichier gcloud CLI:

Installez la CLI gcloud.
Mettez à jour votre installation de gcloud CLI pour bénéficier des dernières fonctionnalités :
```
gcloud components update
```

Exécuter l'émulateur

Exécutez la commande suivante pour démarrer l'émulateur :
```
gcloud emulators firestore start
```
L'émulateur imprime l'hôte et le numéro de port sur lequel il s'exécute.

Par défaut, l'émulateur tente d'utiliser 127.0.0.1:8080. Pour lier l'émulateur à un hôte et à un port spécifiques, utilisez l'option facultative --host-port, en remplaçant HOST et PORT :
```
gcloud emulators firestore start --host-port=HOST:PORT
```
Saisissez Control + C pour arrêter l'émulateur. L'émulateur peut également être arrêté avec un POST sur /shutdown. Exemple :
```
curl -d '' HOST:PORT/shutdown
```

Se connecter à l'émulateur

La méthode de connexion à l'émulateur dépend du type de bibliothèque cliente, de bibliothèque cliente de serveur ou de SDK mobile/Web.

Bibliothèques clientes de serveur

Pour connecter une bibliothèque cliente de serveur Firestore (C#, Go, Java, Node.js, PHP, Python et Ruby), définissez la variable d'environnement FIRESTORE_EMULATOR_HOST. Lorsque cet environnement est définie, les bibliothèques clientes du serveur se connectent automatiquement à l'émulateur.

export FIRESTORE_EMULATOR_HOST="HOST:PORT"

Android, plates-formes Apple et SDK Web

Les exemples suivants montrent comment connecter les plates-formes Android, Apple et les SDK Web à l'émulateur Firestore :

Android

// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
FirebaseFirestore firestore = FirebaseFirestore.getInstance();
firestore.useEmulator("10.0.2.2", 8080);

FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder()
        .setPersistenceEnabled(false)
        .build();
firestore.setFirestoreSettings(settings);EmulatorSuite.java

Swift

let settings = Firestore.firestore().settings
settings.host = "127.0.0.1:8080"
settings.cacheSettings = MemoryCacheSettings()
settings.isSSLEnabled = false
Firestore.firestore().settings = settingsViewController.swift

Version Web 9

import { getFirestore, connectFirestoreEmulator } from "firebase/firestore";

// firebaseApps previously initialized using initializeApp()
const db = getFirestore();
connectFirestoreEmulator(db, '127.0.0.1', 8080);fs_emulator_connect.js

Version Web 8

// Firebase previously initialized using firebase.initializeApp().
var db = firebase.firestore();
if (location.hostname === "localhost") {
  db.useEmulator("127.0.0.1", 8080);
}emulator-suite.js

L'émulateur Firestore efface le contenu de la base de données à l'arrêt. Depuis le cache hors connexion du SDK Firestore n'est pas automatiquement vidé, vous pouvez désactiver la persistance locale dans la configuration de l'émulateur pour éviter des écarts entre la base de données émulée et les caches locaux ; dans le SDK Web, la persistance est désactivée par défaut.

Effacer les données de l'émulateur

L'émulateur Firestore inclut un point de terminaison REST permettant de supprimer toutes les données actuellement dans l'émulateur. Vous pouvez utiliser ce point de terminaison pour effacer les données entre les tests sans arrêter l'émulateur.

Pour supprimer toutes les données dans l'émulateur, effectuez une opération HTTP DELETE sur le point de terminaison suivant, en remplaçant HOST et PORT par hôte et le port que vous avez sélectionnés, en remplaçant PROJECT_ID par votre ID de votre propre projet:

http://HOST:PORT/emulator/v1/projects/PROJECT_ID/databases/(default)/documents

Ajustez l'hôte et le port si l'émulateur n'utilise pas 127.0.0.1:8080. Votre code doit attendre la confirmation REST que la suppression est terminée ou a échoué.

Vous pouvez effectuer cette opération à partir du shell à l'aide de curl :

$ curl -v -X DELETE "http://HOST:PORT/emulator/v1/projects/PROJECT_ID/databases/(default)/documents"

Différences entre l'émulateur Firestore et la production

L'émulateur Firestore tente de reproduire fidèlement le comportement du service de production, avec quelques limitations notables.

Transactions

L'émulateur n'implémente pas tous les comportements de transaction observées en production. Lorsque vous testez des fonctionnalités impliquant plusieurs écritures simultanées dans un même document, l'émulateur peut être lent à traiter les requêtes d'écriture. Dans certains cas, la libération des serrures peut prendre jusqu'à 30 secondes. Envisagez d'ajuster les délais avant expiration des tests en conséquence, si nécessaire.

Index

L'émulateur ne suit pas les index composites et exécute plutôt toute requête valide. Veillez à tester votre application sur une vraie base de données Firestore pour déterminer les index dont vous avez besoin.

Limites

L'émulateur n'applique pas toutes les limites appliquées en production. Par exemple : l'émulateur peut autoriser des transactions qui seraient rejetées car trop volumineuses par le de production. Assurez-vous de connaître les limites documentées et de concevoir votre application pour les éviter de manière proactive.