WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

IDBCursor — über IndexedDB-Datensätze iterieren

IDBCursor liest IndexedDB-Datensätze nacheinander in Schlüsselreihenfolge. Ein Cursor mit Wert stellt cursor.value bereit, während cursor.continue() asynchron zum nächsten Datensatz weitergeht.

Version: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Syntax

const request = store.openCursor();
request.onsuccess = () => {
  const cursor = request.result;
  if (!cursor) return;
  const value = cursor.value;
  cursor.continue();
};

IDBCursor bezeichnet eine Position beim Durchlaufen eines IndexedDB-Objektspeichers oder Indexes. openCursor() gibt ein IDBRequest zurück, keinen Cursor. Lies request.result in onsuccess; fehlt ein Cursor, ist die Iteration beendet. Die Standardrichtung next bedeutet aufsteigende Schlüsselreihenfolge, nicht Einfügereihenfolge.

Der Name IDBCursor.value ist eine beschreibende Kurzform: Die Eigenschaft value wird tatsächlich von IDBCursorWithValue definiert, das von IDBCursor erbt. openCursor() stellt diesen Cursor bereit; openKeyCursor() stellt value nicht bereit. Änderungen an einem von cursor.value zurückgegebenen Objekt werden nicht gespeichert. Verwende zum Speichern update() in einer readwrite-Transaktion.

IDBCursor.continue, aufgerufen als cursor.continue(), plant den nächsten Schritt und gibt undefined zurück, kein Promise. Das Ergebnis kommt in einem weiteren success-Ereignis derselben Anfrage an. Rufe die Methode pro Schritt einmal in einer aktiven Transaktion auf: Ein erneuter Aufruf vor dem Ergebnis verursacht InvalidStateError; bei einer inaktiven Transaktion tritt TransactionInactiveError auf. Warte zwischen den Schritten nicht auf unabhängige asynchrone Vorgänge.

Dies ist eine Web-API und kein Teil von ECMAScript; Node 24 zu haben, belegt keine Unterstützung. Die beschriebenen Vorgänge sind in Indexed Database API 2.0 und 3.0 spezifiziert. Prüfe die Unterstützung und Speicherverfügbarkeit im Zielbrowser.

Beispiele

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Iterating records with IDBCursor</title>
</head>
<body>
<script>
  (() => {
    // This disposable name does not require a secure-context API.
    const name = `cktis-cursor-${Date.now()}-${Math.random()}`;
    const unavailable = () => console.log('IndexedDB unavailable in this context.');
    let open;
    try {
      open = indexedDB.open(name, 1);
    } catch {
      unavailable();
      return;
    }
    open.onerror = unavailable;
    open.onupgradeneeded = () => {
      const store = open.result.createObjectStore('items');
      store.put('Beta', 2);
      store.put('Alpha', 1);
    };
    open.onsuccess = () => {
      const db = open.result;
      const rows = [];
      const tx = db.transaction('items', 'readonly');
      const request = tx.objectStore('items').openCursor();
      request.onsuccess = () => {
        const cursor = request.result;
        if (cursor === null) return;
        rows.push(`${cursor.key}: ${cursor.value}`);
        cursor.continue();
      };
      function cleanup() {
        db.close();
        indexedDB.deleteDatabase(name);
      }
      tx.oncomplete = () => {
        for (const row of rows) console.log(row);
        cleanup();
      };
      tx.onabort = () => {
        cleanup();
        console.log('Cursor transaction aborted.');
      };
    };
  })();
</script>
</body>
</html>

Ergebnis

1: Alpha
2: Beta

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen