IDBObjectStore: createIndex() Methode

Syntax

createIndex(indexName, keyPath)
createIndex(indexName, keyPath, options)

Parameter

indexName

Der Name des zu erstellenden Indexes. Beachten Sie, dass es möglich ist, einen Index mit einem leeren Namen zu erstellen.

keyPath

Der Schlüsselpfad, den der Index verwenden soll. Beachten Sie, dass es möglich ist, einen Index mit einem leeren keyPath zu erstellen, und auch eine Sequenz (Array) als keyPath zu übergeben.

options Optional

Ein Objekt, das die folgenden Eigenschaften enthalten kann:

unique

Wenn true, erlaubt der Index keine doppelten Werte für einen einzelnen Schlüssel. Standardwert ist false.

multiEntry

Wenn true, wird ein Eintrag im Index für jedes Array-Element hinzugefügt, wenn der keyPath zu einem Array aufgelöst wird. Wenn false, wird ein einziger Eintrag mit dem Array hinzugefügt. Standardwert ist false.

locale Nicht standardisiert Veraltet

Ermöglicht die Angabe einer Lokalisierung für den Index. Alle über Schlüsselbereiche durchgeführten Sortieroperationen halten dann die Sortierregeln dieser Lokalisierung ein. Sie können seinen Wert auf eine der drei folgenden Arten angeben:

• string: Eine Zeichenfolge, die einen spezifischen Lokalisierungscode enthält, z. B. en-US oder pl.
• auto: Die Standard-Lokalisierung der Plattform wird verwendet (kann durch Benutzereinstellungen geändert werden).
• null oder undefined: Wenn keine Lokalisierung angegeben ist, wird das normale JavaScript-Sortieren verwendet - nicht lokalisierungsbewusst.

Rückgabewert

Ein IDBIndex-Objekt: der neu erstellte Index.

Ausnahmen

Diese Methode kann ein DOMException der folgenden Typen auslösen:

ConstraintError DOMException

Wird ausgelöst, wenn ein Index mit demselben Namen bereits in der Datenbank existiert. Indexnamen sind groß-/klein-schreibungsempfindlich.

InvalidAccessError DOMException

Wird ausgelöst, wenn der angegebene Schlüsselpfad eine Sequenz ist und multiEntry im objectParameters-Objekt auf true gesetzt ist.

InvalidStateError DOMException

Wird ausgelöst, wenn:

• Die Methode nicht aus einem versionchange-Transaktionsmodus-Callback heraus aufgerufen wurde, d.h. aus einem onupgradeneeded-Handler.
• Der Objekt-Store gelöscht wurde.

SyntaxError DOMException

Wird ausgelöst, wenn der angegebene keyPath kein gültiger Schlüsselpfad ist.

TransactionInactiveError DOMException

Wird ausgelöst, wenn die Transaktion, zu der dieses IDBObjectStore gehört, nicht aktiv ist (z. B. gelöscht oder entfernt wurde). In Firefox vor Version 41 wurde in diesem Fall ebenfalls ein InvalidStateError ausgelöst, was irreführend war; dies wurde nun behoben (siehe Firefox Bug 1176165).

Beispiele

Im folgenden Beispiel sehen Sie den onupgradeneeded-Handler, der verwendet wird, um die Datenbankstruktur zu aktualisieren, wenn eine Datenbank mit einer höheren Versionsnummer geladen wird. createIndex() wird verwendet, um neue Indizes im Objekt-Store zu erstellen. Ein vollständiges Beispiel finden Sie in unserer To-do Notifications-App (Beispiel live ansehen).

let db;

// Let us open our database
const DBOpenRequest = window.indexedDB.open("toDoList", 4);

// Two event handlers for opening the database.
DBOpenRequest.onerror = (event) => {
  note.appendChild(document.createElement("li")).textContent =
    "Error loading database.";
};

DBOpenRequest.onsuccess = (event) => {
  note.appendChild(document.createElement("li")).textContent =
    "Database initialized.";

  // store the result of opening the database in the db variable.
  // This is used a lot below.
  db = request.result;

  // Run the displayData() function to populate the task list with
  // all the to-do list data already in the IDB
  displayData();
};

// This handler fires when a new database is created and indicates
// either that one has not been created before, or a new version
// was submitted with window.indexedDB.open(). (See above.)
// It is only implemented in recent browsers.
DBOpenRequest.onupgradeneeded = (event) => {
  const db = event.target.result;

  db.onerror = (event) => {
    note.appendChild(document.createElement("li")).textContent =
      "Error loading database.";
  };

  // Create an objectStore for this database
  const objectStore = db.createObjectStore("toDoList", {
    keyPath: "taskTitle",
  });

  // define what data items the objectStore will contain

  objectStore.createIndex("hours", "hours", { unique: false });
  objectStore.createIndex("minutes", "minutes", { unique: false });
  objectStore.createIndex("day", "day", { unique: false });
  objectStore.createIndex("month", "month", { unique: false });
  objectStore.createIndex("year", "year", { unique: false });
  objectStore.createIndex("notified", "notified", { unique: false });
};

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Verwendung von IndexedDB
• Beginn von Transaktionen: IDBDatabase
• Verwendung von Transaktionen: IDBTransaction
• Festlegung eines Schlüsselbereichs: IDBKeyRange
• Abrufen und Anpassen Ihrer Daten: IDBObjectStore
• Verwendung von Cursorn: IDBCursor
• Referenzbeispiel: To-do Notifications (Beispiel live ansehen).