Diese Seite wurde von der Cloud Translation API übersetzt.
Switch to English

Indexierung

Indexe sind ein wichtiger Faktor für die Leistung einer Datenbank. Ähnlich wie der Index (bzw. das Register) eines Buchs, in dem die Seitenzahlen zu den Themen im Buch stehen, gibt ein Datenbankindex die Positionen der Elemente in der Datenbank an. Wenn Sie eine Abfrage an eine Datenbank senden, kann die Datenbank einen Index verwenden, um schnell die Positionen der angeforderten Elemente zu ermitteln.

Auf dieser Seite werden die beiden von Firestore verwendeten Indextypen erläutert: Einzelfeldindexe und zusammengesetzte Indexe.

Ein Index hinter jeder Abfrage

Wenn für eine Abfrage kein Index vorhanden ist, erfassen die meisten Datenbanken die in ihnen enthaltenen Elemente nach und nach. Das ist ein langsamer Vorgang, der mit zunehmender Datenbankgröße auch immer mehr Zeit benötigt. Firestore garantiert eine hohe Abfrageleistung durch Nutzung von Indexen für alle Abfragen. Dadurch hängt die Abfrageleistung von der Größe der Ergebnismenge und nicht von der Anzahl der Elemente in der Datenbank ab.

Weniger Indexverwaltung, mehr Anwendungsentwicklung

Firestore bietet Features, mit denen sich der Zeitaufwand für die Indexverwaltung reduzieren lässt. Die für grundlegende Abfragen erforderlichen Indexe werden automatisch für Sie erstellt. Wenn Sie Ihre Anwendung verwenden und testen, bietet Firestore eine Unterstützung für das Ermitteln und Erstellen zusätzlicher Indexe, die von der Anwendung benötigt werden.

Indexarten

Firestore nutzt zwei Arten von Indexen: Einzelfeldindexe und zusammengesetzte Indexe. Neben der Anzahl der indexierten Felder unterscheiden sich Einzelfeldindexe und zusammengesetzte Indexe hinsichtlich der Art und Weise der Verwaltung.

Einzelfeldindexe

Bei einem Einzelfeldindex wird eine sortierte Zuordnung aller Dokumente, die ein bestimmtes Feld enthalten, in einer Sammlung gespeichert. Jeder Eintrag in einem Einzelfeldindex erfasst den Wert eines Dokuments für ein bestimmtes Feld sowie die Position des Dokuments in der Datenbank. Firestore nutzt diese Indexe für viele grundlegende Abfragen. Zum Verwalten von Einzelfeldindexen müssen Sie die Einstellungen der Datenbank für die automatische Indexierung sowie die Indexausnahmen konfigurieren.

Automatische Indexierung

Standardmäßig verwaltet Firestore automatisch Einzelfeldindexe für jedes Feld in einem Dokument und für jedes Unterfeld in einer Map. Bei Firestore gelten für Einzelfeldindexe die folgenden Standardeinstellungen:

  • Für jedes Nicht-Arrayfeld und jedes Nicht-Map-Feld definiert Firestore zwei Einzelfeldindexe im Sammlungsbereich: einen im aufsteigenden und einen im absteigenden Modus.

  • Für jedes Map-Feld erstellt Firestore einen aufsteigenden Index des Sammlungsbereichs. Für jedes Unterfeld in der Map, das kein Array-und kein Map-Feld ist, wird ein absteigender Index angelegt.

  • Für jedes Arrayfeld in einem Dokument erstellt und verwaltet Firestore einen "Array-contains"-Index des Sammlungsbereichs.

  • Einzelfeldindexe mit Sammlungsgruppenbereich werden nicht standardmäßig bereitgestellt.

Einzelfeldindex-Ausnahmen

Sie können ein Feld durch Erstellen einer Einzelfeldindex-Ausnahme von der automatischen Indexierung ausschließen. Eine Indexausnahme überschreibt die datenbankweiten Einstellungen für die automatische Indexierung. Eine Ausnahme kann einen Einzelfeldindex aktivieren, der durch die Einstellungen für die automatische Indexierung ansonsten deaktiviert werden würde, oder einen Einzelfeldindex deaktivieren, der durch die Einstellungen für die automatische Indexierung ansonsten aktiviert werden würde. Beispiele für Fälle, in denen Ausnahmen nützlich sein können, finden Sie in den Best Practices zur Indexierung.

Wenn Sie eine Einzelfeldindex-Ausnahme für ein Map-Feld erstellen, werden diese Einstellungen für die Unterfelder der Karte übernommen. Sie können jedoch Einzelfeldindex-Ausnahmen für bestimmte Unterfelder definieren. Wenn Sie eine Ausnahme für ein Unterfeld löschen, übernimmt das Unterfeld die Ausnahme-Einstellungen des übergeordneten Felds, sofern vorhanden, und ansonsten die datenbankweiten Einstellungen.

Informationen zum Erstellen und Verwalten von Einzelfeldindex-Ausnahmen finden Sie unter Indexe in Firestore verwalten.

Zusammengesetzte Indexe

Ein zusammengesetzter Index speichert eine sortierte Zuordnung aller Dokumente in einer Sammlung anhand einer sortierten Liste von Feldern, die indexiert werden sollen.

Firestore nutzt zusammengesetzte Indexe für Abfragen, die noch nicht von Einzelfeldindexen unterstützt werden.

Bei Firestore werden zusammengesetzte Indexe aufgrund der großen Anzahl möglicher Feldkombinationen nicht wie Einzelfeldindexe automatisch erstellt. Stattdessen bietet Firestore eine Unterstützung für das Ermitteln und Erstellen der erforderlichen zusammengesetzte Indexe, wenn Sie Ihre Anwendung entwickeln.

Wenn Sie die obige Abfrage ausführen, ohne zuvor den erforderlichen Index zu erstellen, gibt Firestore eine Fehlermeldung mit einem Link aus, über den Sie den fehlenden Index anlegen können. Dies erfolgt jedes Mal, wenn Sie eine Abfrage auszuführen versuchen, die vom jeweiligen Index nicht unterstützt wird. Sie können zusammengesetzte Indexe auch manuell definieren oder verwalten, indem Sie die Console oder Firebase CLI verwenden. Weitere Informationen zum Erstellen und Verwalten von zusammengesetzten Indexen finden Sie unter Indexe verwalten.

Indexmodi und Abfragebereiche

Sie konfigurieren Einzelfeldindexe und zusammengesetzte Indexe unterschiedlich, aber beide erfordern das Konfigurieren von Indexmodi und Abfragebereichen.

Indexmodi

Wenn Sie einen Index definieren, wählen Sie für jedes indexierte Feld einen Indexmodus aus. Der Indexmodus jedes Felds unterstützt bestimmte Abfrageklauseln für das Feld. Sie können aus den folgenden Indexmodi auswählen:

Indexmodus Beschreibung
Aufsteigend  Unterstützt Abfrageklauseln des Typs <, <=, ==, >=, > und in für das Feld sowie Sortierergebnisse in aufsteigender Reihenfolge basierend auf dem Feldwert
Absteigend  Unterstützt Abfrageklauseln des Typs <, <=, ==, >=, > und in für das Feld sowie Sortierergebnisse in absteigender Reihenfolge basierend auf dem Feldwert
Array‑contains Unterstützt array-contains- und array-contains-any-Abfrageklauseln für das Feld

Abfrageumfänge

Jeder Index ist entweder einer Sammlung oder einer Sammlungsgruppe zugeordnet. Dies wird als Abfragebereich des Index bezeichnet.

Sammlungsbereich
Firestore erstellt standardmäßig Indexe mit Sammlungsbereich. Diese Indexe unterstützen Abfragen, die Ergebnisse aus einer einzelnen Sammlung zurückgeben.

Umfang der Sammlungsgruppe
Eine Sammlungsgruppe enthält alle Sammlungen mit derselben Sammlungs-ID. Um eine Sammlungsgruppenabfrage auszuführen, die gefilterte oder geordnete Ergebnisse aus einer Sammlungsgruppe zurückgibt, müssen Sie einen entsprechenden Index mit Sammlungsgruppenbereich erstellen.

Indexierungsbeispiel

Durch das automatische Erstellen von Einzelfeldindexen bietet Firestore eine schnelle Unterstützung grundlegender Datenbankabfragen für Ihre Anwendung. Mithilfe von Einzelfeldindexen können Sie einfache Abfragen ausführen, die auf Feldwerten sowie auf den Vergleichsoperatoren <, <=, ==, >=, > und in beruhen. Für Arrayfelder ermöglichen sie die Ausführung von array-contains- und array-contains-any-Abfragen.

Betrachten Sie zur Veranschaulichung die folgenden Beispiele aus der Sicht der Indexerstellung. Mit dem folgenden Snippet werden einige city-Dokumente in einer cities-Sammlung erstellt und für jedes Dokument die Felder name, state, country, capital, population und tags festgelegt:

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

Wenn für die automatische Indexierung die Standardeinstellungen gelten, aktualisiert Firestore einen aufsteigenden Einzelfeldindex pro Nicht-Arrayfeld, einen absteigenden Einzelfeldindex pro Nicht-Arrayfeld sowie einen "Array-contains"-Einzelfeldindex für das Arrayfeld. Jede Zeile in der folgenden Tabelle steht für einen Eintrag in einem Einzelfeldindex:

Sammlung Indexiertes Feld Abfragebereich
cities name Sammlung
cities state Sammlung
cities country Sammlung
cities capital Sammlung
cities population Sammlung
cities name Sammlung
cities state Sammlung
cities country Sammlung
cities capital Sammlung
cities population Sammlung
cities array-contains Regionen Sammlung

Von Einzelfeldindexen unterstützte Abfragen

Mit diesen automatisch erstellten Einzelfeldindexen können Sie einfache Abfragen wie die folgenden ausführen:

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

Sie können auch in- und kumulierende Gleichheitsabfragen erstellen {==}:

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)

Wenn Sie ein kumulierende Abfrage ausführen müssen, die einen Bereichsvergleich (<, <=, > oder >=) verwendet, oder wenn Sie nach einem anderen Feld sortieren müssen, ist es erforderlich, für diese Abfrage einen zusammengesetzten Index zu erstellen.

Mit dem array-contains-Index können Sie das Arrayfeld regions abfragen:

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"])

Von zusammengesetzten Indexen unterstützte Abfragen

Firestore verwendet zusammengesetzte Indexe für kumulierende Abfragen, die noch nicht von Einzelfeldindexen unterstützt werden. Einen zusammengesetzten Index benötigen Sie beispielsweise für die folgenden Abfragen:

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)

Für diese Abfragen ist der unten stehende zusammengesetzte Index erforderlich. Da die Abfrage für das Feld country einen Gleichheitsoperator (== oder in) verwendet, können Sie für dieses Feld den aufsteigenden oder absteigenden Indexmodus verwenden. Standardmäßig wird bei Ungleichheitsklauseln eine aufsteigende Sortierreihenfolge angewendet, die auf dem Feld in der Ungleichheitsklausel basiert.

Sammlung Indexierte Felder Abfragebereich
cities (oder ) country, population Sammlung

Um dieselben Abfragen mit absteigender Sortierreihenfolge auszuführen, benötigen Sie für population einen zusätzlichen zusammengesetzten Index in absteigender Reihenfolge:

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")
Sammlung Indexierte Felder Abfragebereich
cities country, population Sammlung
cities country, population Sammlung

Außerdem müssen Sie einen zusammengesetzten Index erstellen, um eine array-contains- oder array-contains-any-Abfrage mit zusätzlichen Klauseln zu kombinieren.

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)
Sammlung Indexierte Felder Abfragebereich
cities array-contains tags, (oder ) capital Sammlung

Von Sammlungsgruppenindexen unterstützte Abfragen

Um einen Index mit Sammlungsgruppenbereich zu verstehen, stellen Sie sich vor, Sie fügen einigen der city-Dokumente eine landmarks-Untersammlung hinzu:

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

Mithilfe des folgenden Einzelfeldindex mit Sammlungsbereich können Sie die landmarks-Sammlung einer einzelnen Stadt basierend auf dem Feld category abfragen:

Sammlung Indexierte Felder Abfragebereich
landmarks (oder ) category Sammlung
Web
citiesRef.doc("SF").collection("landmarks").where("category", "==", "park")
citiesRef.doc("SF").collection("landmarks").where("category", "in", ["park", "museum"])

Angenommen, Sie möchten die Sehenswürdigkeiten in allen Städten abfragen. Um diese Abfrage für die Sammlungsgruppe auszuführen, die alle landmarks-Sammlungen umfasst, müssen Sie einen landmarks-Einzelfeldindex mit Sammlungsgruppenbereich aktivieren:

Sammlung Indexierte Felder Abfragebereich
landmarks (oder ) category Sammlungsgruppe

Wenn dieser Index aktiviert ist, können Sie die landmarks-Sammlungsgruppe abfragen:

Web
var landmarksGroupRef = db.collectionGroup("landmarks");

landmarksGroupRef.where("category", "==", "park")
landmarksGroupRef.where("category", "in", ["park", "museum"])

Wenn Sie eine Sammlungsgruppenabfrage ausführen möchten, die gefilterte oder geordnete Ergebnisse zurückgibt, müssen Sie einen entsprechenden Einzelfeldindex oder zusammengesetzten Index mit Sammlungsgruppenbereich aktivieren. Sammlungsgruppenabfragen, die keine Ergebnisse filtern oder ordnen, erfordern jedoch keine zusätzlichen Indexdefinitionen.

Sie können beispielsweise die folgende Sammlungsgruppenabfrage ausführen, ohne einen zusätzlichen Index zu aktivieren:

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

Indexeinträge

Sowohl die konfigurierten Indexe Ihres Projekts als auch die Struktur eines Dokuments wirken sich auf die Indexeinträge für das Dokument aus, die schließlich auf das Limit der Indexeinträge angerechnet werden.

Im Folgenden finden Sie ein Beispiel zur Veranschaulichung:

Dokument

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

Einzelfeldindexe

  • (Automatisch) Name aufsteigend und absteigend
  • (Automatisch) Temperatur aufsteigend und absteigend
  • (Automatisch) Stadtviertel Array-contains

Zusammengesetzte Indexe

  • Name aufsteigend, Stadtviertel aufsteigend
  • Name absteigend, Stadtviertel aufsteigend

Daraus resultierende Indexeinträge

Diese Indexierungskonfiguration führt zu den folgenden zwölf Indexeinträgen für das Dokument:

Index Eintrag
Name aufsteigend und absteigend Name: "San Francisco"
Temperatur aufsteigend und absteigend Temperatur.Sommer: 67
Temperatur aufsteigend und absteigend Temperatur.Winter: 55
Stadtviertel Array-contains Stadtviertel: "Mission"
Stadtviertel Array-contains Stadtviertel: "Downtown"
Stadtviertel Array-contains Stadtviertel: "Marina"
Name aufsteigend, Stadtviertel aufsteigend Name: "San Francisco", Stadtviertel: "Mission"
Name aufsteigend, Stadtviertel aufsteigend Name: "San Francisco", Stadtviertel: "Downtown"
Name aufsteigend, Stadtviertel aufsteigend Name: "San Francisco", Stadtviertel: "Marina"
Name absteigend, Stadtviertel aufsteigend Name: "San Francisco", Stadtviertel: "Mission"
Name absteigend, Stadtviertel aufsteigend Name: "San Francisco", Stadtviertel: "Downtown"
Name absteigend, Stadtviertel aufsteigend Name: "San Francisco", Stadtviertel: "Marina"

Indexe und Preise

Indexe tragen zu den Speicherkosten Ihrer Anwendung bei. Weitere Informationen zur Berechnung der Speichergröße für Indexe finden Sie unter Größe des Indexeintrags.

Vorteile der Indexzusammenführung

Auch wenn Firestore für jede Abfrage einen Index verwendet, ist nicht immer ein Index pro Abfrage erforderlich. Bei Abfragen mit mehreren Gleichheitsklauseln (==) und optional einer orderBy-Klausel kann Firestore vorhandene Indexe wiederverwenden. Mit Firestore besteht die Möglichkeit, die Indexe für einfache Gleichheitsfilter zusammenzuführen und auf diese Weise die zusammengesetzten Indexe zu erstellen, die für umfangreichere Gleichheitsabfragen benötigt werden.

Sie können die Indexierungskosten reduzieren, wenn Sie prüfen, welche Situationen sich für die Indexzusammenführung eignen. Stellen Sie sich beispielsweise eine Sammlung restaurants für eine Anwendung zur Restaurantbewertung vor:

  • restaurants

    • burgerthyme

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

Angenommen, diese Anwendung verwendet Abfragen wie die unten stehenden. Beachten Sie, dass die Anwendung Kombinationen aus Gleichheitsklauseln für category, city und editors_pick verwendet und dabei immer aufsteigend nach star_rating sortiert:

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

Sie können für jede Abfrage einen Index erstellen:

Sammlung Indexierte Felder Abfragebereich
restaurants category, star_rating Sammlung
restaurants city, star_rating Sammlung
restaurants category, city, star_rating Sammlung
restaurants category, city, editors_pick, star_rating Sammlung

Als bessere Lösung können Sie die Anzahl der Indexe reduzieren und dafür die Möglichkeit von Firestore nutzen, Indexe für Gleichheitsklauseln zusammenzuführen:

Sammlung Indexierte Felder Abfragebereich
restaurants category, star_rating Sammlung
restaurants city, star_rating Sammlung
restaurants editors_pick, star_rating Sammlung

Dieser Indexsatz ist nicht nur kleiner, sondern unterstützt auch eine zusätzliche Abfrage:

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

Limits für die Indexierung

Die folgenden Limits gelten für Indexe. Informationen zu allen Kontingenten und Limits finden Sie unter Kontingente und Limits.

Limit Details
Maximale Anzahl zusammengesetzter Indexe für eine Datenbank 200
Maximale Anzahl Einzelfeld-Index-Ausnahmen für eine Datenbank 200

Maximale Anzahl Indexeinträge für jedes Dokument

40.000

Die Anzahl der Indexeinträge ist die Summe von Folgendem für ein Dokument:

  • Anzahl der Einzelfeld-Indexeinträge
  • Anzahl zusammengesetzter Indexeinträge

Informationen darüber, wie Firestore ein Dokument und einen Indexsatz in Indexeinträge umwandelt, finden Sie in diesem Beispiel für das Zählen von Indexeinträgen.

Maximale Größe eines Indexeintrags

7,5 KB

Informationen darüber, wie Firestore die Größe von Indexeinträgen berechnet, erhalten Sie unter Größe des Indexeintrags.

Maximale Summe der Größen der Indexeinträge eines Dokuments

8 MiB

Die Gesamtgröße ist die Summe von Folgendem für ein Dokument:

  • Summe der Größen der Einzelfeld-Indexeinträge eines Dokuments
  • Summe der Größen der zusammengesetzten Indexeinträge eines Dokuments
  • Maximale Größe des Werts eines indexierten Felds

    1.500 Byte

    Feldwerte über 1.500 Byte werden abgeschnitten. Abfragen unter Beteiligung von abgeschnittenen Feldwerten können inkonsistente Ergebnisse zurückgeben.

    Best Practices zur Indexierung

    Bei den meisten Anwendungen sind die automatische Indexierung sowie Fehlermeldungslinks zur Verwaltung der Indexe ausreichend. In den folgenden Fällen können Sie aber Ausnahmen für einzelne Felder hinzufügen:

    Case Beschreibung
    Große Stringfelder

    Wenn Sie ein Stringfeld haben, das oft lange Stringwerte enthält, die Sie nicht für Abfragen verwenden, können Sie die Speicherkosten senken, indem Sie das Feld von der Indexierung ausnehmen.

    Hohe Schreibraten für eine Sammlung, die Dokumente mit aufeinanderfolgenden Werten enthält

    Wenn Sie ein Feld indexieren, dessen Werte über die Dokumente einer Sammlung hinweg kontinuierlich zu- oder abnehmen, z. B. im Fall eines Zeitstempels, beträgt die maximale Schreibrate für die Sammlung 500 Schreibvorgänge pro Sekunde. Wenn Sie keine Abfrage basierend auf dem Feld mit aufeinanderfolgenden Werten durchführen, können Sie das Feld von der Indexierung ausnehmen, um dieses Limit zu umgehen.

    In einem IoT-Anwendungsfall mit einer hohen Schreibrate kann sich beispielsweise eine Sammlung, die Dokumente mit einem Zeitstempelfeld enthält, dem Limit von 500 Schreibvorgängen pro Sekunde nähern.

    Große Array- oder Map-Felder

    Große Array- oder Map-Felder können schnell das Limit von 20.000 Indexeinträgen pro Dokument erreichen. Wenn Sie keine Abfragen anahnd eines Array- oder Map-Felds ausführen, sollten Sie ein solches Feld von der Indexierung ausnehmen.