Gérer les index

API MongoDB

Utilisez la méthode createIndex() pour créer un index. Exemple :

•   db.restaurants.createIndex({"cuisine" : 1})
    

•   db.restaurants.createIndex({"cuisine" : 1}, {sparse: true})
    

• La création d'index avec db.runCommand() est également acceptée avec un index au maximum.

    db.runCommand({"createIndexes":"restaurant", "index": [{"key": {"cuisine":1}, {"name": "cuisine_index"}]})
    

Prenez note des restrictions suivantes :

• Vous ne pouvez créer qu'un seul index par requête. db.collection.createIndexes() n'est pas compatible.
• Les journaux d'audit pour la création d'index avec l'API MongoDB utilisent le nom de méthode google.firestore.admin.v1.FirestoreAdmin.CreateIndex.
• Pour connaître les options d'index compatibles, consultez Index et propriétés d'index.

Console Firebase

1. Dans la console Firebase, accédez à la page Base de données Firestore.

   Accéder à la base de données Firestore

2. Sélectionnez une base de données dans la liste.
3. Dans l'onglet Index, cliquez sur Créer un index.
4. Saisissez un ID de collection.
5. Ajoutez un ou plusieurs chemins de champ, puis sélectionnez une option d'index pour chacun d'eux.
6. Sélectionnez une option de présence de champ, non éparse ou éparse.
7. Vous pouvez éventuellement définir l'option Index multiclés.
8. Cliquez sur Créer.
9. Votre nouvel index s'affiche dans la liste des index et Cloud Firestore commence à le créer. Une fois votre index créé, une coche verte apparaît à côté de l'index. Si l'index n'est pas créé, consultez Erreurs de création d'index pour connaître les causes possibles.

gcloud CLI

Pour créer un index, utilisez la commande gcloud firestore indexes composite create. Définissez api-scope sur mongodb-compatible-api.

gcloud firestore indexes composite create \
--database='DATABASE_ID' \
--collection-group=COLLECTION \
--field-config=FIELD_CONFIGURATION \
--query-scope=collection-group \
--density=dense \
--api-scope=mongodb-compatible-api

Remplacez les éléments suivants :

• DATABASE_ID : ID de base de données.
• COLLECTION : nom d'une collection.
• FIELD_CONFIGURATION : configuration de champ. Pour chaque champ, ajoutez --field-config=field-path=. Exemple :

      --field-config=field-path=user-id,order=descending \
      --field-config=field-path=score,order=descending
      

  Pour en savoir plus sur la configuration de ces champs, consultez --field-config.

Pour créer un index creux, définissez --density=sparse-any.

Pour créer un index multiclés, ajoutez l'option --multikey.

Pour créer un index unique, ajoutez l'indicateur --unique.

Terraform

Utilisez la ressource google_firestore_index, puis définissez api_scope sur MONGODB_COMPATIBLE_API et query_scope sur COLLECTION_GROUP.

resource "google_firestore_index" "index" {
  database    = "DATABASE_ID"
  collection  = "COLLECTION"
  api_scope   = "MONGODB_COMPATIBLE_API"
  query_scope = "COLLECTION_GROUP"

  // You can include multiple field blocks
  fields {
    field_path = "FIELD_PATH"
    order      = "ORDER"
  }

  // Optional
  multikey = true
  density  = "DENSITY"
}

Remplacez les éléments suivants :

• DATABASE_ID : ID de la base de données que vous avez choisie
• COLLECTION : nom de la collection à indexer.
• FIELD_PATH : nom du champ à indexer
• ORDER : ASCENDING ou DESCENDING
• DENSITY : SPARSE_ANY ou DENSE

API MongoDB

Utilisez la méthode createIndex() pour créer un index de texte. Dans l'exemple suivant, lorsqu'un document est écrit dans la collection cities avec les champs country ou food renseignés, ces champs sont indexés à des fins de recherche.

db.cities.createIndex({"country": "text", "food": "text"})

Pour être indexé, un champ doit être une chaîne ou un tableau de chaînes. Les index de tableaux ne sont pas indexés pour la recherche. Par conséquent, l'indexation de a.1.b indexera something dans {a: {1: {b: something}}}, mais pas dans {a: [one, {b: something}]}.

Vous pouvez également créer des index avec db.runCommand(). Vous ne pouvez avoir qu'un seul index de texte par collection, mais vous pouvez créer plusieurs index de différents types dans un db.runCommand(). L'exemple suivant utilise db.runCommand() pour créer un index de texte :

db.runCommand({
  createIndexes: "cities",
  indexes: [
    {
      key: { "country": "text", "food": "text" },
      name: "country_text_food_text"
    }
  ]
})

Spécifier une langue par défaut

Vous pouvez également spécifier une langue par défaut ou un chemin de champ dans votre document qui contiendra la langue par défaut.

Dans l'exemple suivant, myLanguageField est spécifié comme language_override. Lorsqu'un document de la collection cities contient un champ nommé myLanguageField, la valeur de ce champ est utilisée pour déterminer la langue d'indexation du champ country pour ce document spécifique. Cette valeur remplace la langue par défaut de french.

db.cities.createIndex({"country": "text"}, {"default_language": "french", "language_override": "myLanguageField"})

• Vous pouvez saisir une langue sous sa forme longue (english) ou sous son code de langue ISO à deux lettres (en).
• Si la langue par défaut n'est pas définie, Cloud Firestore est défini sur l'anglais par défaut.
• Le champ de remplacement de la langue doit être un champ de niveau supérieur. Si ce champ n'est pas défini, la valeur par défaut est language.
• Si vous définissez la langue par défaut sur le caractère null, Cloud Firestore n'utilise aucun champ comme remplacement de langue.

Partitionner un index de texte

Vous pouvez également partitionner votre index à l'aide d'un champ afin de pouvoir filtrer les requêtes par valeur de champ spécifique. Cette configuration vous permet d'exécuter des requêtes plus performantes si vous avez toujours besoin d'un champ spécifique filtré dans l'index que vous interrogez.

Pour créer un index avec une partition, configurez le champ firestoreOptions comme suit :

db.runCommand({
  createIndexes: "cities",
  indexes: [
    {
      key: { "country": "text", "food": "text"},
      name: "country_text_food_text"
      firestoreOptions: {"customPartitionFields": ["PARTITIONED_FIELD"]
    }
  ]
})

Où :

• PARTITIONED_FIELD est le nom du champ utilisé pour la partition. Cette valeur doit être une chaîne et doit faire référence à un champ de premier niveau. Lorsque vous exécutez une requête sur un index partitionné, vous pouvez filtrer les résultats en fonction d'une valeur de ce champ. Par exemple, vous pouvez partitionner votre index à l'aide de city. Si un champ city est défini dans votre index de texte, les utilisateurs peuvent interroger une ville spécifique.

  La partition ne doit comporter qu'un seul champ. Si vous partitionnez un index, vous ne pouvez exécuter que des requêtes dans lesquelles le champ partitionné est spécifié.

Limites

• Vous ne pouvez créer qu'un seul index par requête.
• Les journaux d'audit pour la création d'index avec l'API MongoDB utilisent le nom de méthode google.firestore.admin.v1.FirestoreAdmin.CreateIndex.
• Pour connaître les options d'index compatibles, consultez Index et propriétés d'index.

Console Firebase

1. Dans la consoleFirebase, accédez à la page Base de données Firestore.

   Accéder à la base de données Firestore

2. Sélectionnez une base de données dans la liste.

3. Dans l'onglet Index, cliquez sur Créer un index.

4. Saisissez un ID de collection.

5. Ajoutez un ou plusieurs chemins de champ, puis sélectionnez une option d'index pour chacun d'eux.

6. Cliquez sur Créer.

7. Votre nouvel index apparaît dans la liste des index et les opérations compatibles avec MongoDB commencent à le créer. Une fois que votre index est créé, une coche verte apparaît à côté de l'index. Si l'index n'est pas créé, consultez Erreurs de création d'index pour connaître les causes possibles.

API MongoDB

Utilisez la méthode createIndex() pour créer un index. Exemple :

db.restaurants.createIndex({"location" : "2dsphere", "region": "2dsphere"})

La création d'index avec db.runCommand() est également acceptée avec au maximum un index :

db.runCommand({
  createIndexes: "restaurants",
  indexes: [
    {
      key: { "location": "2dsphere", "region": "2dsphere" },
      name: "location_2dsphere_region_2dsphere"
    }
  ]
})

Partitionner un index 2dsphere

Vous pouvez également partitionner votre index à l'aide d'un champ afin de pouvoir filtrer les requêtes par valeur de champ spécifique. Cette configuration vous permet d'exécuter des requêtes plus performantes si vous avez toujours besoin d'un champ spécifique filtré dans l'index que vous interrogez.

Pour créer un index avec une partition, configurez le champ firestoreOptions comme suit :

db.runCommand({
  createIndexes: "restaurants",
  indexes: [
    {
      key: { "location": "2dsphere", "region": "2dsphere" },
      name: "location_2dsphere_region_2dsphere"
      firestoreOptions: {"customPartitionFields": ["PARTITIONED_FIELD"]
    }
  ]
})

Où :

• PARTITIONED_FIELD est le nom du champ utilisé pour la partition. Lorsque vous exécutez une requête sur un index partitionné, vous pouvez filtrer les résultats en fonction d'une valeur de ce champ. Par exemple, si votre index comporte un champ region pour les zones géographiques, vous pouvez partitionner votre index à l'aide de region afin que les utilisateurs puissent interroger les restaurants de leur région.

  Si vous partitionnez un index, vous ne pouvez exécuter des requêtes que lorsque le champ partitionné est spécifié.

Limites

• Vous ne pouvez créer qu'un seul index par requête.
• Les journaux d'audit pour la création d'index avec l'API MongoDB utilisent le nom de méthode google.firestore.admin.v1.FirestoreAdmin.CreateIndex.
• Pour connaître les options d'index compatibles, consultez Index et propriétés d'index.

Console Firebase

1. Dans la consoleFirebase, accédez à la page Base de données Firestore.

   Accéder à la base de données Firestore

2. Sélectionnez une base de données dans la liste.

3. Dans l'onglet Index, cliquez sur Créer un index.

4. Saisissez un ID de collection.

5. Ajoutez un ou plusieurs chemins de champ, puis sélectionnez une option d'index pour chacun d'eux.

6. Cliquez sur Créer.

7. Votre nouvel index apparaît dans la liste des index et les opérations compatibles avec MongoDB commencent à le créer. Une fois que votre index est créé, une coche verte apparaît à côté de l'index. Si l'index n'est pas créé, consultez Erreurs de création d'index pour connaître les causes possibles.

API MongoDB

Utilisez la méthode dropIndex() pour supprimer un index. Exemple :

Supprimer un index à l'aide de son nom

db.restaurants.dropIndex("cuisine_index")

Supprimer un index à l'aide de la définition d'index

db.restaurants.dropIndex({"cuisine" : 1})

Console Firebase

1. Dans la console Firebase, accédez à la page Base de données Firestore.

   Accéder à la base de données Firestore

2. Sélectionnez une base de données dans la liste.
3. Cliquez sur l'onglet Index.
4. Dans la liste des index, sélectionnez Supprimer dans le bouton Plus more_vert de l'index que vous souhaitez supprimer.
5. Cliquez sur Supprimer l'index.

gcloud CLI

1. Pour trouver le nom de l'index, utilisez la commande gcloud firestore indexes composite list.

   gcloud firestore indexes composite list \
   --database='DATABASE_ID'

   Remplacez DATABASE_ID par l'ID de la base de données.

2. Pour supprimer l'index, utilisez la commande gcloud firestore indexes composite delete.

   gcloud firestore indexes composite delete INDEX_NAME \
   --database='DATABASE_ID'

   Remplacez les éléments suivants :

   • INDEX_NAME : nom d'un index
   • DATABASE_ID : ID de la base de données