Présentation de l'indexation

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 envoyez une requête, l'index permet à la base de données interrogée de trouver rapidement les emplacements des éléments que vous avez demandés.

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

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. Pour garantir des performances de requêtes élevées, Firestore fait appel à des 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

Firestore inclut des fonctionnalités qui vous permettent de consacrer moins de temps à gérer des index. Les index requis pour traiter les requêtes les plus simples sont créés automatiquement. Firestore vous aide à identifier et à créer d'autres index requis à mesure que vous utilisez et testez votre application.

Types d'index

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. 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, 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, Firestore utilise les paramètres par défaut suivants :

  • Pour chaque champ non issu d'un tableau ou d'une carte, 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, Firestore crée un index croissant dont le champ d'application est défini sur une collection. Pour chaque sous-champ de la carte non issu d'un tableau ou d'une carte, un index décroissant est créé.

  • Pour chaque champ de tableau d'un document, 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.

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 découvrir comment créer et gérer des exceptions d'index à champ unique, consultez la page Gérer les index dans Firestore.

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.

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

À l'inverse des index à champ unique, les index composites ne sont pas créés automatiquement par Firestore en raison du grand nombre de combinaisons de champs possibles. Firestore vous aide toutefois à identifier et créer les index composites requis à mesure que vous développez votre application.

Si vous essayez d'envoyer la requête ci-dessus sans avoir créé l'index requis au préalable, Firestore affiche un message d'erreur contenant un lien que vous pouvez suivre pour créer l'index manquant. Cette erreur se produit chaque fois que vous essayez d'envoyer une requête non prise en charge par un index. 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 :

Mode d'index Description
Croissant Le champ accepte les clauses de requête <, <=, ==, >=, > et in, et les résultats sont triés par ordre croissant en fonction de la valeur de ce champ.
Décroissant Le champ accepte les clauses de requête <, <=, ==, >=, > et in, et les résultats sont triés par ordre décroissant en fonction de la valeur de ce champ.
Array‑contains Le champ accepte les clauses de requête array-contains et array-contains-any.

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
Par défaut, Firestore crée des index qui s'appliquent à une collection. 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.

Exemple d'indexation

Firestore crée automatiquement des index à champ unique, ce qui permet à votre application de prendre en charge rapidement les requêtes de bases 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 :

Web
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"] });

Firestore devine les paramètres d'indexation automatiques par défaut afin de mettre à 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 :

Collection Champ indexé Champ d'application de la requête
cities name Collection
cities state Collection
cities country Collection
cities capital Collection
cities population Collection
cities name Collection
cities state Collection
cities country Collection
cities capital Collection
cities population Collection
cities array-contains regions Collection

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 :

Web
citiesRef.where("state", "==", "CA")
citiesRef.where("population", "<", 100000)
citiesRef.where("name", ">=", "San Francisco")

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

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

Web
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

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

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

Collection Champs indexés Champ d'application de la requête
cities (ou ) country, population Collection

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 :

Web
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")
Collection Champs indexés Champ d'application de la requête
cities country, population Collection
cities country, population Collection

Vous devez également créer un index composite pour associer une requête array-contains ou array-contains-any à des clauses supplémentaires.

Web
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)
Collection Champs indexés Champ d'application de la requête
cities tags array-contains, (ou ) capital Collection

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, imaginons que vous ajoutiez une sous-collection landmarks à certains des documents de la collection city :

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

Collection Champs indexés Champ d'application de la requête
landmarks (ou ) category Collection
Web
citiesRef.doc("SF").collection("landmarks").where("category", "==", "park")
citiesRef.doc("SF").collection("landmarks").where("category", "in", ["park", "museum"])

Maintenant, imaginez que vous souhaitez interroger les points de repère de toutes les villes. Pour exécuter cette requête sur le groupe de collections qui se compose de toutes les collections landmarks, vous devez activer un index à champ unique landmarks dont le champ d'application est défini sur un groupe de collections :

Collection Champs indexés Champ d'application de la requête
landmarks (ou ) category Groupe de collections

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

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

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

Entrées d'index

Les index configurés de votre projet, ainsi que la structure d'un document, ont une incidence sur les entrées d'index du document, qui sont comptabilisées dans le nombre maximal d'entrées d'index.

Voici un exemple pour illustrer.

Document

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

Index à champ unique

  • (Automatique) name ASC & DESC (nom CROISS. et DÉCROISS.)
  • (Automatique) temperatures ASC & DESC (température CROISS. et DÉCROISS.)
  • (Automatique) neighborhoods Array Contains (quartiers Tableau contient)

Index composites

  • name ASC, neighborhoods ASC (nom CROISS., quartiers CROISS.)
  • name DESC, neighborhoods ASC (nom DÉCROISS., quartiers CROISS.)

Entrées d'index résultantes

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

Index Entrée
name ASC & DESC name: "San Francisco"
temperatures ASC & DESC temperatures.summer: 67
temperatures ASC & DESC temperatures.winter: 55
neighborhoods Array Contains neighborhoods: "Mission"
neighborhoods Array Contains neighborhoods: "Downtown"
neighborhoods Array Contains neighborhoods: "Marina"
name ASC, neighborhoods ASC name: "San Francisco", neighborhoods: "Mission"
name ASC, neighborhoods ASC name: "San Francisco", neighborhoods: "Downtown"
name ASC, neighborhoods ASC name: "San Francisco", neighborhoods: "Marina"
name DESC, neighborhoods ASC name: "San Francisco", neighborhoods: "Mission"
name DESC, neighborhoods ASC name: "San Francisco", neighborhoods: "Downtown"
name DESC, neighborhoods ASC (nom DÉCROISS., quartiers CROISS.) name: "San Francisco", neighborhoods: "Marina"

Index et tarifs

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

Tirer parti de la fusion d'index

Bien que chaque requête effectuée dans Firestore utilise un index, 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, Firestore peut réutiliser des index existants. Firestore est capable de 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. Imaginons, par exemple, une collection restaurants associée à une application de notation de restaurants :

  • restaurants

    • burgerthyme

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

Imaginons maintenant que cette application utilise des requêtes similaires à celles répertoriées ci-dessous. Vous remarquerez que l'application utilise des combinaisons de clauses d'égalité pour category, city et editors_pick tout en triant toujours star_rating par ordre croissant :

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

Collection Champs indexés Champ d'application de la requête
restaurants category, star_rating Collection
restaurants city, star_rating Collection
restaurants category, city, star_rating Collection
restaurants category, city, editors_pick, star_rating Collection

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 Firestore :

Collection Champs indexés Champ d'application de la requête
restaurants category, star_rating Collection
restaurants city, star_rating Collection
restaurants editors_pick, star_rating Collection

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

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

Limites d'indexation

Les limites suivantes s'appliquent aux index. Pour plus d'informations sur l'ensemble des quotas et limites, consultez la page Quotas et limites.

Limite Détails
Nombre maximal d'index composites pour une base de données 200
Nombre maximal d'exceptions d'index à champ unique pour une base de données 200

Nombre maximal d'entrées d'index pour chaque document

40 000

Le nombre d'entrées d'index représente la somme des entrées suivantes pour un document :

  • Nombre d'entrées d'index à champ unique
  • Nombre d'entrées d'index composite

Pour savoir comment Firestore transforme un document et un ensemble d'index en entrées d'index, consultez cet exemple de nombre d'entrées d'index.

Taille maximale d'une entrée d'index

7,5 Kio

Pour savoir comment Firestore calcule la taille des entrées d'index, consultez la page Taille des entrées d'index.

Somme maximale des tailles d'entrée d'index d'un document

8 Mio

La taille totale représente la somme des tailles suivantes pour un document :

  • Somme des tailles d'entrée d'index à champ unique d'un document
  • Somme des tailles d'entrée d'index composite d'un document
  • Taille maximale d'une valeur de champ indexé

    1 500 octets

    Les valeurs de champ au-delà de 1 500 octets sont tronquées. Les requêtes impliquant des valeurs de champ tronquées peuvent renvoyer des résultats incohérents.

    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 :

    Cas Description
    Champs de chaîne volumineux

    S'il existe un champ de chaîne contenant souvent des chaînes longues que vous n'utilisez pas pour les requêtes, vous pouvez réduire les coûts de stockage en excluant le champ de l'indexation.

    Taux d'écriture élevés dans une collection contenant des documents avec des valeurs séquentielles

    Si vous indexez un champ qui augmente ou diminue séquentiellement entre les documents d'une collection, comme un horodatage, le taux d'écriture maximal pour la collection est de 500 écritures par seconde. Si vous ne faites pas de requête en fonction du champ avec des valeurs séquentielles, vous pouvez exclure le champ de l'indexation pour contourner cette limite.

    Par exemple, dans le cas d'un IoT avec un taux d'écriture élevé, une collection contenant des documents avec un champ d'horodatage peut approcher la limite des 500 écritures par seconde.

    Champs de tableau ou de carte volumineux

    Les champs de tableau ou de carte volumineux peuvent approcher la limite de 20 000 entrées d'index par document. Si vous ne faites pas de requête en fonction d'un champ de tableau ou de carte volumineux, vous devez exclure ce champ de l'indexation.