Types d'index dans Cloud Firestore

Les index sont un facteur important de performances pour une base de données. Tout comme le sommaire d'un livre qui indique la correspondance des sujets avec des numéros de page, l'index d'une base de données associe les éléments qu'elle contient à leur emplacement. Lorsque vous interrogez une base de données, celle-ci peut utiliser un indice pour identifier rapidement les emplacements des éléments que vous avez demandés.

Cette page décrit les deux types d'index utilisés par Cloud Firestore : les index à champ unique et les index composites.

Définition et structure des index

Un index est défini sur une liste de champs d'un document donné, avec un mode d'index correspondant pour chaque champ.

Un index contient une entrée pour chaque champ nommé dans la définition de l'index. L'index inclut tous les documents qui constituent des résultats potentiels pour les requêtes basées sur l'index. Un document n'est inclus dans l'index que s'il dispose d'une valeur indexée pour chaque champ utilisé dans l'index. Si la définition de l'index fait référence à un champ pour lequel aucune valeur n'est définie dans le document, ce document n'apparaîtra pas dans l'index. Dans ce cas, le document ne sera jamais renvoyé en tant que résultat pour une requête basée sur l'index.

L'index composite est trié par valeurs de champ, dans l'ordre spécifié dans la définition de l'index.

Un index derrière chaque requête

Si aucun index n'est disponible pour une requête, la plupart des bases de données parcourent un à un les éléments qu'elles contiennent. Ce processus devient de plus en plus lent à mesure que la base de données s'agrandit. Cloud Firestore garantit des performances de requête élevées grâce à l'utilisation d'index pour toutes les requêtes. Ainsi, les performances des requêtes dépendent de la taille de l'ensemble de résultats et non du nombre d'éléments disponibles dans la base de données.

Une gestion d'index aisée pour développer plus rapidement

Cloud Firestore inclut des fonctionnalités qui vous permettent de consacrer moins de temps à la gestion des index. Les index requis pour les requêtes les plus élémentaires sont créés automatiquement. Lorsque vous utilisez et testez votre application, Cloud Firestore vous aide à identifier et à créer d'autres index requis par votre application.

Types d'index

Cloud Firestore utilise deux types d'index: les index à champ unique et les index composites. Outre le nombre de champs indexés, les index à champ unique et les index composites diffèrent dans la façon dont vous les gérez.

Index à champ unique

Un index à champ unique stocke un tri de correspondances entre tous les documents d'une collection qui contiennent un seul champ spécifique. Chaque entrée d'un index à champ unique enregistre la valeur d'un document pour un champ spécifique ainsi que l'emplacement du document dans la base de données. Cloud Firestore exécute de nombreuses requêtes élémentaires à l'aide de ces index. Pour gérer les index à champ unique, vous devez configurer les paramètres d'indexation automatique et les exceptions d'index de votre base de données.

Indexation automatique

Par défaut, Cloud Firestore conserve automatiquement des index à champ unique pour chaque champ d'un document et chaque sous-champ d'une carte. Pour les index à champ unique, Cloud Firestore utilise les paramètres par défaut suivants:

• Pour chaque champ non issu d'un tableau ou d'une carte, Cloud Firestore crée deux index à champ unique dont le champ d'application est défini sur une collection, l'un en mode croissant et l'autre en mode décroissant.

• Pour chaque champ de carte, Cloud Firestore crée les éléments suivants:

  • Un index croissant dont le champ d'application est défini sur une collection pour chaque sous-champ non issu d'un tableau ou d'une carte.
  • Un index décroissant dont le champ d'application est défini sur une collection pour chaque sous-champ non issu d'un tableau ou d'une carte.
  • Un index "array-contains" de portée collection pour chaque sous-champ de tableau.
  • Cloud Firestore indexe de manière récursive chaque sous-champ de la carte.

• Pour chaque champ de tableau d'un document, Cloud Firestore crée et conserve un index "array-contains" dont le champ d'application est défini sur une collection.

• Les index à champ unique dont le champ d'application est défini sur un groupe de collections ne sont pas conservés par défaut.

Exceptions d'index à champ unique

Vous pouvez exclure un champ de vos paramètres d'indexation automatique en créant une exception d'index à champ unique. Les exceptions d'indexation vous permettent de remplacer les paramètres d'index automatiques de votre base de données. Une exception permet d'activer un index à champ unique qui était à l'origine désactivé par vos paramètres d'indexation automatiques. À l'inverse, vous pouvez désactiver un index à champ unique qui était à l'origine activé par l'indexation automatique. Pour découvrir dans quelles situations utiliser les exceptions, consultez les bonnes pratiques en matière d'indexation.

Utilisez la valeur du chemin de champ * pour ajouter des exceptions d'index au niveau de la collection pour tous les champs d'un groupe de collections. Par exemple, pour le groupe de collections comments, définissez le chemin d'accès au champ sur * pour faire correspondre tous les champs du groupe de collections comments et désactivez l'indexation de tous les champs du groupe de collections. Vous pouvez ensuite ajouter des exceptions pour n'indexer que les champs requis pour vos requêtes. Réduire le nombre de champs indexés réduit les coûts de stockage et peut améliorer les performances d'écriture.

Si vous créez une exception d'index à champ unique pour un champ de carte, les sous-champs de la carte héritent de ces paramètres. Vous pouvez toutefois définir des exceptions d'index à champ unique pour des sous-champs spécifiques. Si vous supprimez une exception pour un sous-champ, le sous-champ hérite des paramètres d'exception de son parent, s'ils existent. Si aucune exception n'existe pour le parent, le sous-champ hérite des paramètres de base de données.

Pour créer et gérer des exceptions d'index à champ unique, consultez la page Gérer les index.

Index composites

Un index composite stocke un tri de correspondances entre tous les documents d'une collection, en fonction d'une liste numérotée de champs à indexer.

Cloud Firestore utilise des index composites pour accepter les requêtes qui ne sont pas déjà prises en charge par des index à champ unique.

Cloud Firestore ne crée pas automatiquement d'index composites comme il le fait pour les index à champ unique en raison du grand nombre de combinaisons de champs possibles. Cloud Firestore vous aide toutefois à identifier et créer les index composites requis à mesure que vous développez votre application.

Chaque fois que vous essayez d'envoyer une requête non prise en charge par un index, Cloud Firestore renvoie un message d'erreur avec un lien que vous pouvez suivre pour créer l'index manquant.

Vous pouvez aussi définir et gérer manuellement des index composites à l'aide de la console ou de l'interface en ligne de commandes CLI Firebase. Pour découvrir comment créer et gérer des index composites, consultez la page Gérer les index.

Modes d'index et champs d'application des requêtes

Même si la configuration des index à champ unique diffère de celle des index composites, vous devez configurer les modes d'index et les champs d'application des requêtes pour les deux types d'index.

Modes d'index

Lorsque vous définissez un index, vous sélectionnez un mode d'index pour chaque champ indexé. Le mode d'index de chaque champ accepte des clauses de requête spécifiques à ce champ. Vous pouvez choisir parmi les modes d'index suivants :

Champs d'application des requêtes

Chaque index s'applique à une collection ou à un groupe de collections. C'est ce qu'on appelle le champ d'application des requêtes d'index :

Champ d'application de la collection

Cloud Firestore crée des index qui s'appliquent à une collection par défaut. Ces index acceptent les requêtes qui renvoient les résultats d'une seule collection.

Champ d'application du groupe de collections

Un groupe de collections inclut toutes les collections possédant le même identifiant. Pour obtenir des résultats filtrés ou triés d'un groupe de collections lorsque vous exécutez une requête de groupe de collections, vous devez créer un index correspondant qui s'applique au groupe de collections.

Tri par défaut et champ __name__

En plus de trier les documents en fonction des modes d'indexation spécifiés pour chaque champ (ascendant ou descendant) , les index appliquent un tri final en fonction du champ __name__ de chaque document. La valeur du champ __name__ est définie sur le chemin d'accès complet du document. Cela signifie que les documents du résultat ayant les mêmes valeurs de champ sont triés par chemin d'accès au document.

Par défaut, le champ __name__ est trié dans la même direction que le dernier champ trié dans la définition de l'index. Exemple :

Pour trier les résultats en fonction de la direction __name__ non par défaut, vous devez créer cet indice.

Indexer les propriétés

Un indice qui permet d'exécuter la requête de manière plus efficace est défini par les propriétés suivantes:

• Champs utilisés dans les filtres d'égalité
• Champs utilisés dans les ordres de tri
• Champs utilisés dans les filtres de plage et d'inégalité (qui ne sont pas déjà inclus dans les ordres de tri)
• Champs utilisés dans les agrégations (qui ne sont pas déjà inclus dans les ordres de tri, les filtres de plage et d'inégalité)

Cloud Firestore calcule les résultats des requêtes comme suit:

1. Identifie l'index correspondant à la collection, aux propriétés de filtre, aux opérateurs de filtre et aux ordres de tri de la requête.
2. Identifie la position d'index à partir de laquelle l'analyse commence. La position de début est précédée des filtres d'égalité de la requête et se termine par les filtres de plage et d'inégalité du premier champ orderBy.
3. Il commence à analyser l'index, en renvoyant chaque document qui répond à tous les filtres, jusqu'à ce que le processus d'analyse effectue l'une des opérations suivantes :
   • rencontre un document qui ne répond pas aux conditions de filtre et confirme qu'aucun document ultérieur ne répondra jamais entièrement aux conditions de filtre ;
   • Atteint la fin de l'index.
   • Collecte le nombre maximal de résultats demandés par la requête.

Exemple d'indexation

Cloud Firestore crée automatiquement des index à champ unique, ce qui permet à votre application de prendre en charge rapidement les requêtes de base de données les plus simples. Les index à champ unique vous permettent d'effectuer des requêtes simples à partir des valeurs des champs et des comparateurs <, <=, ==, >=, > et in. Pour les champs de tableau, les index à champ unique vous permettent d'effectuer des requêtes array-contains et array-contains-any.

Examinez les exemples suivants qui illustrent les index à champ unique du point de vue de leur création. L'extrait de code suivant permet de créer des documents city dans une collection cities et de définir les champs name, state, country, capital, population et tags pour chaque document :

var citiesRef = db.collection("cities");

citiesRef.doc("SF").set({
    name: "San Francisco", state: "CA", country: "USA",
    capital: false, population: 860000,
    regions: ["west_coast", "norcal"] });
citiesRef.doc("LA").set({
    name: "Los Angeles", state: "CA", country: "USA",
    capital: false, population: 3900000,
    regions: ["west_coast", "socal"] });
citiesRef.doc("DC").set({
    name: "Washington, D.C.", state: null, country: "USA",
    capital: true, population: 680000,
    regions: ["east_coast"] });
citiesRef.doc("TOK").set({
    name: "Tokyo", state: null, country: "Japan",
    capital: true, population: 9000000,
    regions: ["kanto", "honshu"] });
citiesRef.doc("BJ").set({
    name: "Beijing", state: null, country: "China",
    capital: true, population: 21500000,
    regions: ["jingjinji", "hebei"] });
test.firestore.js

En supposant que les paramètres d'indexation automatique par défaut sont appliqués, Cloud Firestore met à jour un index à champ unique croissant et un index à champ unique décroissant pour chaque champ non issu d'un tableau, ainsi qu'un index à champ unique "array-contains" pour le champ de tableau. Chaque ligne du tableau suivant représente une entrée dans un index à champ unique :

Requêtes acceptées par les index à champ unique

À l'aide de ces index à champ unique créés automatiquement, vous pouvez exécuter des requêtes simples comme suit :

const stateQuery = citiesRef.where("state", "==", "CA");
const populationQuery = citiesRef.where("population", "<", 100000);
const nameQuery = citiesRef.where("name", ">=", "San Francisco");
test.firestore.js

Vous pouvez également créer des requêtes in et des requêtes d'égalité composées (==) :

citiesRef.where('country', 'in', ["USA", "Japan", "China"])

// Compound equality queries
citiesRef.where("state", "==", "CO").where("name", "==", "Denver")
citiesRef.where("country", "==", "USA")
         .where("capital", "==", false)
         .where("state", "==", "CA")
         .where("population", "==", 860000)

Si vous devez exécuter une requête composée en comparant des plages (<, <=, > ou >=) ou si vous devez trier les résultats en fonction d'un autre champ, vous devez créer un index composite pour cette requête.

L'index array-contains vous permet d'interroger le champ de tableau regions :

citiesRef.where("regions", "array-contains", "west_coast")
// array-contains-any and array-contains use the same indexes
citiesRef.where("regions", "array-contains-any", ["west_coast", "east_coast"])

Requêtes acceptées par les index composites

Cloud Firestore utilise des index composites pour accepter les requêtes composées qui ne sont pas déjà prises en charge par des index à champ unique. Par exemple, les requêtes suivantes nécessitent un index composite :

citiesRef.where("country", "==", "USA").orderBy("population", "asc")
citiesRef.where("country", "==", "USA").where("population", "<", 3800000)
citiesRef.where("country", "==", "USA").where("population", ">", 690000)
// in and == clauses use the same index
citiesRef.where("country", "in", ["USA", "Japan", "China"])
         .where("population", ">", 690000)

Ces requêtes nécessitent d'utiliser l'index composite ci-dessous. Étant donné que la requête utilise une clause d'égalité (== ou in) pour le champ country, vous pouvez utiliser un mode d'index croissant ou décroissant pour ce champ. Par défaut, les clauses d'inégalité appliquent un ordre de tri croissant en fonction du champ qu'elles concernent.

Pour exécuter les mêmes requêtes avec un ordre de tri décroissant, vous devez créer un index composite supplémentaire en appliquant le sens décroissant à population :

citiesRef.where("country", "==", "USA").orderBy("population", "desc")

citiesRef.where("country", "==", "USA")
         .where("population", "<", 3800000)
         .orderBy("population", "desc")

citiesRef.where("country", "==", "USA")
         .where("population", ">", 690000)
         .orderBy("population", "desc")

citiesRef.where("country", "in", ["USA", "Japan", "China"])
         .where("population", ">", 690000)
         .orderBy("population", "desc")

Pour éviter la perte de performances causée par la fusion d'index, nous vous recommandons de créer un indice composite pour combiner une requête array-contains ou array-contains-any avec des clauses supplémentaires:

citiesRef.where("regions", "array-contains", "east_coast")
         .where("capital", "==", true)

// array-contains-any and array-contains use the same index
citiesRef.where("regions", "array-contains-any", ["west_coast", "east_coast"])
         .where("capital", "==", true)

Requêtes acceptées par les index de groupes de collections

Pour illustrer un index dont le champ d'application est défini sur un groupe de collections, ajoutez une sous-collection landmarks à certains des documents de la collection city:

var citiesRef = db.collection("cities");

citiesRef.doc("SF").collection("landmarks").doc().set({
    name: "Golden Gate Bridge",
    category : "bridge" });
citiesRef.doc("SF").collection("landmarks").doc().set({
    name: "Golden Gate Park",
    category : "park" });

citiesRef.doc("DC").collection("landmarks").doc().set({
    name: "National Gallery of Art",
    category : "museum" });
citiesRef.doc("DC").collection("landmarks").doc().set({
    name: "National Mall",
    category : "park" });

Cet index à champ unique dont le champ d'application est défini sur une collection vous permet d'interroger la collection landmarks d'une seule ville en fonction du champ category :

citiesRef.doc("SF").collection("landmarks").where("category", "==", "park")
citiesRef.doc("SF").collection("landmarks").where("category", "in", ["park", "museum"])

Par exemple, si vous souhaitez interroger les points de repère de toutes les villes, exécutez cette requête sur le groupe de collections constitué de toutes les collections landmarks. Vous devez également activer un index à champ unique landmarks dont le champ d'application est défini sur un groupe de collections:

Lorsque cet index est activé, vous pouvez interroger le groupe de collections landmarks :

var landmarksGroupRef = db.collectionGroup("landmarks");

landmarksGroupRef.where("category", "==", "park")
landmarksGroupRef.where("category", "in", ["park", "museum"])

Pour obtenir des résultats filtrés ou triés lorsque vous exécutez une requête de groupe de collections, vous devez activer un index à champ unique ou composite correspondant qui s'applique au groupe de collections. En revanche, si une requête de groupe de collections n'exige pas de trier ou de filtrer les résultats, aucun autre index n'est nécessaire.

Par exemple, vous pouvez exécuter la requête de groupe de collections suivante sans activer d'index supplémentaire :

db.collectionGroup("landmarks").get()

Entrées d'index

Les index configurés de votre projet et la structure d'un document déterminent le nombre d'entrées d'index pour un document. Les entrées d'index sont comptabilisées dans la limite du nombre d'entrées d'index.

L'exemple suivant montre les entrées d'index d'un document.

Document

/cities/SF

city_name : "San Francisco"
temperatures : {summer: 67, winter: 55}
neighborhoods : ["Mission", "Downtown", "Marina"]

Index à champ unique

• city_name ASC
• city_name DESC
• temperatures.summer ASC
• temperatures.summer DESC
• temperatures.winter ASC
• temperatures.winter DESC
• neighborhoods Array Contains (ASC et DESC)

Index composites

• city_name ASC, neighborhoods ARRAY
• city_name DESC, neighborhoods ARRAY

Entrées d'index

Cette configuration d'indexation entraîne les entrées d'index suivantes pour le document:

Index et tarifs

Les coûts de stockage de votre application prennent en compte les index. Pour savoir comment calculer la taille de stockage des index, consultez la page Taille des entrées d'index.

Utiliser la fusion d'index

Bien que Cloud Firestore utilise un index pour chaque requête, il n'est pas nécessaire d'avoir recours à un index unique par requête. Pour les requêtes comportant plusieurs clauses d'égalité (==) et, éventuellement, une clause orderBy, Cloud Firestore peut réutiliser des index existants. Cloud Firestore peut fusionner les index des requêtes d'égalité simples pour créer les index composites requis lorsque vous effectuez des requêtes d'égalité plus volumineuses.

En identifiant les opportunités de fusion d'index, vous pouvez réduire vos frais d'indexation. Par exemple, dans une collection restaurants pour une application de notation de restaurants:

• collections_bookmark restaurants

  • class burgerthyme

    name : "Burger Thyme"
category : "burgers"
city : "San Francisco"
editors_pick : true
star_rating : 4
    

Cette application utilise des requêtes comme celles-ci. L'application utilise des combinaisons de clauses d'égalité pour category, city et editors_pick tout en triant toujours star_rating par ordre croissant:

db.collection("restaurants").where("category", "==", "burgers")
                            .orderBy("star_rating")

db.collection("restaurants").where("city", "==", "San Francisco")
                            .orderBy("star_rating")

db.collection("restaurants").where("category", "==", "burgers")
                            .where("city", "==", "San Francisco")
                            .orderBy("star_rating")

db.collection("restaurants").where("category", "==", "burgers")
                            .where("city", "==" "San Francisco")
                            .where("editors_pick", "==", true )
                            .orderBy("star_rating")

Vous pourriez créer un index pour chaque requête :

Toutefois, une solution plus efficace consiste à réduire le nombre d'index à l'aide de la fusion d'index pour les clauses d'égalité permise par Cloud Firestore:

Non seulement cet ensemble d'index est plus petit, mais il accepte également une requête supplémentaire :

db.collection("restaurants").where("editors_pick", "==", true)
                            .orderBy("star_rating")

Limites d'indexation

Les limites suivantes s'appliquent aux index. Pour en savoir plus sur les quotas et les limites, consultez la section Quotas et limites.

Bonnes pratiques d'indexation

Pour la plupart des applications, vous pouvez compter sur l'indexation automatique et sur les liens affichés dans les messages d'erreur pour gérer vos index. Toutefois, les cas suivants peuvent nécessiter l'ajout d'exceptions de champs uniques :

Si vous utilisez des requêtes avec des opérateurs de plage et d'inégalité sur plusieurs champs, consultez les considérations d'indexation à prendre en compte pour optimiser les performances et les coûts des requêtes Cloud Firestore.

Pour savoir comment résoudre les problèmes d'indexation (fanout d'index, erreurs INVALID_ARGUMENT), consultez la page de dépannage.