KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

IDBIndex — een IndexedDB-index doorzoeken

IDBIndex maakt records in een object store toegankelijk via een secundaire sleutel. Vergelijk het ophalen van een array met getAll() met cursoriteratie via openCursor(), en maak onderscheid tussen indexsleutels en primaire sleutels.

Versie: 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 is een verwijzing naar de secundaire index van een IndexedDB-object store, geen constructor om rechtstreeks te gebruiken. Maak de index met createIndex() tijdens upgradeneeded; haal hem later binnen een transactie op met store.index(name). De index wordt automatisch bijgewerkt met de store.

IDBIndex.getAll(query, count) geeft een IDBRequest terug, geen Promise. Het resultaat is een array met storewaarden, of [] als er geen overeenkomsten zijn. query accepteert een indexsleutel of IDBKeyRange; als je deze weglaat, komen alle items overeen. De optionele parameter count beperkt het aantal resultaten. Als je 0 opgeeft of count weglaat, krijg je alle treffers terug. De volgorde is oplopend op indexsleutel en daarna op primaire sleutel.

IDBIndex.openCursor(query, direction) geeft ook een IDBRequest terug. Lees in success de cursor uit, of null als er geen resultaten meer zijn; continue() start de volgende stap. cursor.key is de indexsleutel, cursor.primaryKey de sleutel van de store en cursor.value het record. De standaardrichting is "next"; alternatieven zijn "prev", "nextunique" en "prevunique".

Met een cursor kun je records stapsgewijs verwerken; getAll() maakt de volledige resultaatarray aan. Dien verzoeken in terwijl de transactie actief is; plaats er geen niet-gerelateerde await tussen. Het voorbeeld gebruikt IndexedDB 2.0-syntaxis, zonder de nieuwere optievorm van getAll(). Controleer je doelbrowser: Node 24 hebben bewijst niet dat deze Web-API wordt ondersteund.

Voorbeelden

<!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>

Resultaat

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

De getoonde code en het opgegeven resultaat zijn in een geïsoleerde omgeving geverifieerd met de methode die in het verificatiebewijs voor exact deze versie is vastgelegd.

Bronnen