Indexe verwalten

MongoDB API

Verwenden Sie die Methode createIndex(), um einen Textindex zu erstellen. Wenn im folgenden Beispiel ein Dokument in die Sammlung cities geschrieben wird und die Felder country oder food ausgefüllt sind, werden diese Felder für Suchzwecke indexiert.

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

Ein Feld muss ein String oder ein Array von Strings sein, um indexiert zu werden. Array-Indexe werden nicht suchindexiert. Daher wird durch die Indexierung von a.1.b something in {a: {1: {b: something}}} indexiert, aber nicht in {a: [one, {b: something}]}.

Sie können Indexe auch mit db.runCommand() erstellen. Sie können nur einen Textindex pro Sammlung haben, aber mehrere Indexe verschiedener Typen in einer 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 angeben

Optional können Sie 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 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 für Cloud Firestore standardmäßig Englisch verwendet.
• Das Feld für die Sprachüberschreibung muss ein Feld auf oberster 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, verwendet Cloud Firestore kein Feld als Sprachüberschreibung.

Textindex partitionieren

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

Wenn Sie einen Index mit einer Partition erstellen möchten, konfigurieren Sie das Feld firestoreOptions so:

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 enthalten. 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 Indexattribute.

Firebase Console

1. Rufen Sie in der Firebase Console die Seite Firestore Database 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 Indexoption aus.

6. Klicken Sie auf Erstellen.

7. Der neue Index wird in der Liste der Indexe angezeigt und MongoDB-kompatible Vorgänge beginnen mit der Erstellung 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 beim Indexaufbau mögliche Ursachen.

gcloud CLI

Verwenden Sie den Befehl gcloud firestore indexes composite create, um einen Textindex zu erstellen. Legen Sie --api-scope auf mongodb-compatible-api fest.

gcloud firestore indexes composite create \
  --database='DATABASE_ID' \
  --collection-group=COLLECTION_GROUP \
  --field-config=field-path=FIELD_NAME,search-config='{"text-spec": {"index-specs": [{"index-type": "tokenized", "match-type": "match-globally"}]}}' \
  --api-scope=mongodb-compatible-api \
  --search-index-options=text-language=en \
  --async

Ersetzen Sie Folgendes:

• DATABASE_ID: eine Datenbank-ID.
• COLLECTION_GROUP: die ID der zu indexierenden Sammlung.
• FIELD_NAME: der Name des zu indexierenden Felds.

Mit dem Flag --async wird der Vorgang zur Indexerstellung im Hintergrund ausgeführt.

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 ebenfalls 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, um Abfragen nach einem bestimmten Feldwert zu filtern. Mit dieser Konfiguration können Sie leistungsfähigere Abfragen ausführen, wenn Sie immer ein bestimmtes Feld im abgefragten Index filtern müssen.

Wenn Sie einen Index mit einer Partition erstellen möchten, konfigurieren Sie das Feld firestoreOptions so:

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 region-Feld für regionale Standorte enthält, können Sie Ihren Index mit region partitionieren, damit Nutzer nach Restaurants in ihrer Region suchen 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 Indexattribute.

Firebase Console

1. Rufen Sie in der Firebase Console die Seite Firestore Database 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 Indexoption aus.

6. Klicken Sie auf Erstellen.

7. Der neue Index wird in der Liste der Indexe angezeigt und MongoDB-kompatible Vorgänge beginnen mit der Erstellung 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 beim Indexaufbau mögliche Ursachen.

gcloud CLI

Verwenden Sie zum Erstellen eines 2dsphere-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_GROUP \
  --field-config=field-path=FIELD_NAME,search-config='{"geo-spec": {}}' \
  --api-scope=mongodb-compatible-api \
  --async

Ersetzen Sie Folgendes:

• DATABASE_ID: eine Datenbank-ID.
• COLLECTION_GROUP: die ID der zu indexierenden Sammlung.
• FIELD_NAME: der Name des zu indexierenden Felds.

Mit dem Flag --async wird der Vorgang zur Indexerstellung im Hintergrund ausgeführt.