IDBCursor: key-Eigenschaft

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Die schreibgeschützte Eigenschaft key der IDBCursor-Schnittstelle gibt den Schlüssel für den Datensatz an der Position des Cursors zurück. Befindet sich der Cursor außerhalb seines Bereichs, wird dies auf undefined gesetzt. Der Schlüssel des Cursors kann jeden Datentyp haben.

Wert

Ein Wert eines beliebigen Typs.

Ausnahmen

InvalidStateError DOMException

Wird ausgelöst, wenn der Cursor fortschreitet oder abgeschlossen ist.

Beispiele

In diesem einfachen Fragment erstellen wir eine Transaktion, rufen einen Objektspeicher ab und verwenden dann einen Cursor, um durch alle Datensätze im Objektspeicher zu iterieren. In jeder Iteration protokollieren wir den Schlüssel des Cursors in der Konsole.

Der Cursor erfordert nicht, dass wir die Daten basierend auf einem Schlüssel auswählen; wir können einfach alles erfassen. Beachten Sie auch, dass Sie in jeder Schleifeniteration Daten aus dem aktuellen Datensatz unter dem Cursor-Objekt mit cursor.value.foo erfassen können. Für ein vollständiges funktionierendes Beispiel siehe unser IDBCursor-Beispiel (Beispiel live ansehen).

js
function displayData() {
  const transaction = db.transaction(["rushAlbumList"], "readonly");
  const objectStore = transaction.objectStore("rushAlbumList");

  objectStore.openCursor().onsuccess = (event) => {
    const cursor = event.target.result;
    if (cursor) {
      const listItem = document.createElement("li");
      listItem.textContent = `${cursor.value.albumTitle}, ${cursor.value.year}`;
      list.appendChild(listItem);

      console.log(cursor.key);
      cursor.continue();
    } else {
      console.log("Entries all displayed.");
    }
  };
}

Spezifikationen

Specification
Indexed Database API 3.0
# ref-for-dom-idbcursor-key①

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch