Gérer les index

API MongoDB

Utilisez la createIndex() méthode 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 compatible 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 la section Index et propriétés d'index.

Firebase console

1. Dans la console Firebase, accédez à la page Firestore Database (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 Indexes (Index), cliquez sur Create Index (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 également définir l'option d'index multiclés.
8. Cliquez sur Create (Créer).
9. Votre nouvel index s'affiche dans la liste des index et Cloud Firestore commence à le créer. Une fois l'index créé, une coche verte s'affiche à côté de celui-ci. Si l'index n'est pas créé, consultez la section Erreurs de création d'index pour connaître les causes possibles.

gcloud CLI

Pour créer un index, utilisez la gcloud firestore indexes composite create commande. 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 de 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 la section --field-config.

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

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

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

Terraform

Utilisez la google_firestore_index ressource et 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 base de données pour la base de données 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 dropIndex() méthode pour supprimer un index. Exemple :

Supprimer un index à l'aide du nom de l'index

db.restaurants.dropIndex("cuisine_index")

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

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

Firebase console

1. Dans la console Firebase, accédez à la page Firestore Database (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 Indexes (Index).
4. Dans la liste des index, cliquez sur le bouton More correspondant à l'index que vous souhaitez supprimer more_vert, puis sélectionnez Delete.
5. Cliquez sur Delete Index (Supprimer l'index).

gcloud CLI

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

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

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

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

   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 base de données.