WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

IDBIndex — eine IndexedDB-Indexabfrage durchführen

IDBIndex stellt Datensätze eines Objektspeichers über einen sekundären Schlüssel bereit. Vergleiche den Abruf eines Arrays mit getAll() mit der Cursor-Iteration über openCursor() und unterscheide Indexschlüssel von Primärschlüsseln.

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 index = transaction.objectStore(storeName).index(indexName);
const valuesRequest = index.getAll(query, count);
const cursorRequest = index.openCursor(query, "next");

IDBIndex ist ein Verweis auf den Sekundärindex eines IndexedDB-Objektspeichers und kein direkt zu verwendender Konstruktor. Erstelle den Index während upgradeneeded mit createIndex(); rufe ihn später innerhalb einer Transaktion mit store.index(name) ab. Der Index wird automatisch zusammen mit dem Speicher aktualisiert.

IDBIndex.getAll(query, count) gibt ein IDBRequest zurück, kein Promise. Das Ergebnis ist ein Array der Speicherwerte oder [], wenn es keine Treffer gibt. query akzeptiert einen Indexschlüssel oder IDBKeyRange; wird es weggelassen, werden alle Einträge gefunden. Der optionale Parameter count begrenzt die Anzahl der Ergebnisse. Bei 0 oder wenn count weggelassen wird, werden alle Treffer zurückgegeben. Die Sortierung erfolgt aufsteigend nach Indexschlüssel und anschließend nach Primärschlüssel.

IDBIndex.openCursor(query, direction) gibt ebenfalls ein IDBRequest zurück. Lies in success den Cursor aus; wenn keine Ergebnisse mehr vorhanden sind, ist er null. continue() startet den nächsten Schritt. cursor.key ist der Indexschlüssel, cursor.primaryKey der Schlüssel des Speichers und cursor.value der Datensatz. Die Standardrichtung ist "next"; weitere Möglichkeiten sind "prev", "nextunique" und "prevunique".

Ein Cursor ermöglicht die schrittweise Verarbeitung; getAll() erstellt das vollständige Ergebnis-Array. Stelle Anfragen, solange die Transaktion aktiv ist, und füge zwischen ihnen kein sachfremdes await ein. Das Beispiel verwendet die IndexedDB-2.0-Syntax ohne die neuere Optionsform von getAll(). Prüfe den Zielbrowser: Node 24 zu haben, belegt nicht die Unterstützung dieser Web-API.

Beispiele

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>IDBIndex: querying a secondary key</title>
</head>
<body>
  <h1>Querying an IndexedDB index</h1>
  <script>
    (() => {
      const name = 'cktis-index-' + crypto.getRandomValues(new Uint32Array(4)).join('-');
      const report = error => console.log(error.name === 'SecurityError'
        ? 'IndexedDB unavailable: SecurityError' : `IndexedDB error: ${error.name}`);
      let factory, opening;
      try {
        factory = window.indexedDB;
        if (!factory) {
          console.log('IndexedDB unavailable: API missing');
          return;
        }
        opening = factory.open(name, 1);
      } catch (error) {
        report(error);
        return;
      }
      let created = false;
      opening.onerror = () => report(opening.error);
      opening.onupgradeneeded = () => {
        created = true;
        const store = opening.result.createObjectStore('tokens', { keyPath: 'id' });
        store.createIndex('byColor', 'color');
        store.add({ id: 2, color: 'blue', token: 'square' });
        store.add({ id: 1, color: 'blue', token: 'circle' });
        store.add({ id: 3, color: 'red', token: 'triangle' });
      };
      opening.onsuccess = () => {
        const db = opening.result;
        if (!created) {
          db.close();
          console.log('Fixture name already in use');
          return;
        }
        const tx = db.transaction('tokens', 'readonly');
        const index = tx.objectStore('tokens').index('byColor');
        const all = index.getAll('blue');
        const scan = index.openCursor('blue');
        const rows = [];
        scan.onsuccess = () => {
          const cursor = scan.result;
          if (cursor) {
            rows.push([cursor.key, cursor.primaryKey, cursor.value.token]);
            cursor.continue();
          }
        };
        const cleanup = () => {
          db.close();
          factory.deleteDatabase(name);
        };
        tx.oncomplete = () => {
          console.log(JSON.stringify(all.result.map(record => record.token)));
          console.log(JSON.stringify(rows));
          cleanup();
        };
        tx.onabort = () => {
          report(tx.error);
          cleanup();
        };
      };
    })();
  </script>
</body>
</html>

Ergebnis

When IndexedDB access is allowed and the query succeeds, both lines show matches for the index key "blue" in ascending primary-key order:
["circle","square"]
[["blue",1,"circle"],["blue",2,"square"]]

If the browser denies IndexedDB access with a SecurityError, the example logs instead:
IndexedDB unavailable: SecurityError

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