Indexe verwalten

MongoDB API

Verwenden Sie die Methode createIndex(), um einen Index zu erstellen. Beispiel:

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

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

• Die Indexerstellung mit db.runCommand() wird ebenfalls unterstützt, allerdings mit maximal einem Index.

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

Beachten Sie die folgenden Beschränkungen:

• Sie können nur einen Index pro Anfrage erstellen. db.collection.createIndexes() wird nicht unterstützt.
• Audit-Logs für die Indexerstellung mit der MongoDB API verwenden den Methodennamen google.firestore.admin.v1.FirestoreAdmin.CreateIndex.
• Informationen zu unterstützten Indexoptionen finden Sie unter Indexe und Indexattribute.

Firebase Console

1. Rufen Sie in der Firebase-Konsole die Seite Firestore-Datenbank auf.

   Zur Firestore-Datenbank

2. Wählen Sie eine Datenbank aus der Liste der Datenbanken aus.
3. Klicken Sie auf dem Tab Indexe auf Index erstellen.
4. Geben Sie eine Sammlungs-ID ein.
5. Fügen Sie einen oder mehrere Feldpfade hinzu und wählen Sie für jeden eine Indexierungsoption aus.
6. Wählen Sie eine Option für die Feldpräsenz aus, entweder „nicht spärlich“ oder „spärlich“.
7. Optional können Sie die Option Multikey-Index festlegen.
8. Klicken Sie auf Erstellen.
9. Ihr neuer Index wird in der Liste der Indexe angezeigt und Cloud Firestore beginnt mit dem Erstellen des Index. Wenn der Index erstellt wurde, wird neben dem Index ein grünes Häkchen angezeigt. Wenn der Index nicht erstellt wird, finden Sie unter Fehler bei der Indexerstellung mögliche Ursachen.

gcloud CLI

Verwenden Sie zum Erstellen eines Index den Befehl gcloud firestore indexes composite create. Legen Sie api-scope auf mongodb-compatible-api fest.

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

Ersetzen Sie Folgendes:

• DATABASE_ID: eine Datenbank-ID.
• COLLECTION: ein Sammlungsname.
• FIELD_CONFIGURATION: eine Feldkonfiguration. Fügen Sie für jedes Feld --field-config=field-path= hinzu. Beispiel:

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

  Weitere Informationen zum Konfigurieren dieser Felder finden Sie unter --field-config.

Um einen spärlichen Index zu erstellen, legen Sie --density=sparse-any fest.

Wenn Sie einen Index mit mehreren Schlüsseln erstellen möchten, fügen Sie das Flag --multikey hinzu.

Wenn Sie einen eindeutigen Index erstellen möchten, fügen Sie das Flag --unique hinzu.

Terraform

Verwenden Sie die Ressource google_firestore_index und legen Sie api_scope auf MONGODB_COMPATIBLE_API und query_scope auf COLLECTION_GROUP fest.

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"
}

Ersetzen Sie Folgendes:

• DATABASE_ID: Die Datenbank-ID für die ausgewählte Datenbank
• COLLECTION: Der Name der zu indexierenden Sammlung
• FIELD_PATH: Der Name des zu indexierenden Felds
• ORDER: Entweder ASCENDING oder DESCENDING
• DENSITY: Entweder SPARSE_ANY oder DENSE

MongoDB API

Verwenden Sie die Methode createIndex(), um einen Textindex zu erstellen. Im folgenden Beispiel werden die Felder country oder food indexiert, wenn ein Dokument mit diesen Feldern in die Sammlung cities geschrieben wird.

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

Ein Feld muss ein String oder ein Array von Strings sein, damit es indexiert werden kann. Array-Indexe werden nicht für die Suche indexiert. Wenn Sie a.1.b indexieren, wird something in {a: {1: {b: something}}}, aber nicht in {a: [one, {b: something}]} indexiert.

Sie können Indexe auch mit db.runCommand() erstellen. Sie können nur einen Textindex pro Sammlung haben, aber mehrere Indexe unterschiedlicher Typen in einem db.runCommand() erstellen. Im folgenden Beispiel wird db.runCommand() verwendet, um einen Textindex zu erstellen:

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

Standardsprache festlegen

Sie können optional auch eine Standardsprache oder einen Feldpfad in Ihrem Dokument angeben, der die Standardsprache enthält.

Im folgenden Beispiel wird myLanguageField als language_override angegeben. Wenn ein Dokument in der Sammlung cities ein Feld mit dem Namen myLanguageField enthält, wird der Wert dieses Felds verwendet, um die Sprache für die Indexierung des Felds country für dieses bestimmte Dokument zu bestimmen. Dieser Wert überschreibt die Standardsprache von french.

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

• Sie können eine Sprache entweder als Langform (english) oder als zweistelligen ISO-Sprachcode (en) eingeben.
• Wenn die Standardsprache nicht festgelegt ist, wird standardmäßig Englisch für Cloud Firestore verwendet.
• Das Feld für die Sprachüberschreibung muss ein Feld der obersten Ebene sein. Wenn das Feld für die Sprachüberschreibung nicht festgelegt ist, wird standardmäßig language verwendet.
• Wenn Sie die Standardsprache auf das Zeichen null festlegen, wird in Cloud Firestore kein Feld als Sprachüberschreibung verwendet.

Textindex partitionieren

Sie können Ihren Index auch mithilfe eines Felds partitionieren, damit Sie Abfragen nach einem bestimmten Feldwert filtern können. Mit dieser Konfiguration können Sie leistungsfähigere Abfragen ausführen, wenn Sie immer ein bestimmtes Feld im Index filtern müssen, den Sie abfragen.

So erstellen Sie einen Index mit einer Partition:firestoreOptions

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

Wobei:

• PARTITIONED_FIELD ist der Name des Felds, das für die Partition verwendet wird. Dieser Wert muss ein String sein und sich auf ein Feld der obersten Ebene beziehen. Wenn Sie eine Abfrage für einen partitionierten Index ausführen, können Sie die Ergebnisse anhand eines Werts dieses Felds filtern. Sie können Ihren Index beispielsweise mit city partitionieren. Wenn in Ihrem Textindex ein city-Feld definiert ist, können Nutzer Abfragen für eine bestimmte Stadt ausführen.

  Die Partition darf nur ein Feld sein. Wenn Sie einen Index partitionieren, können Sie nur Abfragen ausführen, in denen das partitionierte Feld angegeben ist.

Einschränkungen

• Sie können nur einen Index pro Anfrage erstellen.
• Audit-Logs für die Indexerstellung mit der MongoDB API verwenden den Methodennamen google.firestore.admin.v1.FirestoreAdmin.CreateIndex.
• Informationen zu unterstützten Indexoptionen finden Sie unter Indexe und Indexeigenschaften.

Firebase Console

1. Rufen Sie in der Firebase-Konsole die Seite Firestore-Datenbank auf.

   Zur Firestore-Datenbank

2. Wählen Sie eine Datenbank aus der Liste der Datenbanken aus.

3. Klicken Sie auf dem Tab Indexe auf Index erstellen.

4. Geben Sie eine Sammlungs-ID ein.

5. Fügen Sie einen oder mehrere Feldpfade hinzu und wählen Sie für jeden eine Indexierungsoption aus.

6. Klicken Sie auf Erstellen.

7. Ihr neuer Index wird in der Liste der Indexe angezeigt und MongoDB-kompatible Vorgänge beginnen mit dem Erstellen des Index. Wenn der Index erstellt wurde, wird neben dem Index ein grünes Häkchen angezeigt. Wenn kein Index erstellt wird, finden Sie unter Fehler beim Erstellen von Indexen mögliche Ursachen.

MongoDB API

Verwenden Sie die Methode createIndex(), um einen Index zu erstellen. Beispiel:

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

Die Indexerstellung mit db.runCommand() wird auch mit maximal einem Index unterstützt:

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

2dsphere-Index partitionieren

Sie können Ihren Index auch mithilfe eines Felds partitionieren, damit Sie Abfragen nach einem bestimmten Feldwert filtern können. Mit dieser Konfiguration können Sie leistungsfähigere Abfragen ausführen, wenn Sie immer ein bestimmtes Feld im Index filtern müssen, den Sie abfragen.

So erstellen Sie einen Index mit einer Partition:firestoreOptions

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

Wobei:

• PARTITIONED_FIELD ist der Name des Felds, das für die Partition verwendet wird. Wenn Sie eine Abfrage für einen partitionierten Index ausführen, können Sie die Ergebnisse anhand eines Werts dieses Felds filtern. Wenn Ihr Index beispielsweise ein Feld region für regionale Standorte enthält, können Sie ihn mit region partitionieren, damit Nutzer Restaurants in ihrer Region abfragen können.

  Wenn Sie einen Index partitionieren, können Sie nur Abfragen ausführen, in denen das partitionierte Feld angegeben ist.

Einschränkungen

• Sie können nur einen Index pro Anfrage erstellen.
• Audit-Logs für die Indexerstellung mit der MongoDB API verwenden den Methodennamen google.firestore.admin.v1.FirestoreAdmin.CreateIndex.
• Informationen zu unterstützten Indexoptionen finden Sie unter Indexe und Indexeigenschaften.

Firebase Console

1. Rufen Sie in der Firebase-Konsole die Seite Firestore-Datenbank auf.

   Zur Firestore-Datenbank

2. Wählen Sie eine Datenbank aus der Liste der Datenbanken aus.

3. Klicken Sie auf dem Tab Indexe auf Index erstellen.

4. Geben Sie eine Sammlungs-ID ein.

5. Fügen Sie einen oder mehrere Feldpfade hinzu und wählen Sie für jeden eine Indexierungsoption aus.

6. Klicken Sie auf Erstellen.

7. Ihr neuer Index wird in der Liste der Indexe angezeigt und MongoDB-kompatible Vorgänge beginnen mit dem Erstellen des Index. Wenn der Index erstellt wurde, wird neben dem Index ein grünes Häkchen angezeigt. Wenn kein Index erstellt wird, finden Sie unter Fehler beim Erstellen von Indexen mögliche Ursachen.

MongoDB API

Verwenden Sie die Methode dropIndex(), um einen Index zu löschen. Beispiel:

Index anhand des Indexnamens löschen

db.restaurants.dropIndex("cuisine_index")

Index mit Indexdefinition löschen

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

Firebase Console

1. Rufen Sie in der Firebase-Konsole die Seite Firestore-Datenbank auf.

   Zur Firestore-Datenbank

2. Wählen Sie eine Datenbank aus der Liste der Datenbanken aus.
3. Klicken Sie auf den Tab Indexe.
4. Wählen Sie in der Liste der Indexe für den Index, den Sie löschen möchten, über den Button Mehr more_vert die Option Löschen aus.
5. Klicken Sie auf Index löschen.

gcloud CLI

1. Verwenden Sie den Befehl gcloud firestore indexes composite list, um den Namen des Index zu ermitteln.

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

   Ersetzen Sie DATABASE_ID durch die Datenbank-ID.

2. Verwenden Sie den Befehl gcloud firestore indexes composite delete, um den Index zu löschen.

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

   Ersetzen Sie Folgendes:

   • INDEX_NAME: der Name eines Index
   • DATABASE_ID: eine Datenbank-ID