Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

IDBIndex — dotazování nad indexem IndexedDB

IDBIndex zpřístupňuje záznamy objektového úložiště prostřednictvím sekundárního klíče. Porovnejte získání pole pomocí getAll() s iterací kurzoru přes openCursor() a rozlišujte klíče indexu od primárních klíčů.

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

Syntaxe

const index = transaction.objectStore(storeName).index(indexName);
const valuesRequest = index.getAll(query, count);
const cursorRequest = index.openCursor(query, "next");

IDBIndex je odkaz na sekundární index objektového úložiště IndexedDB, nikoli konstruktor určený k přímému použití. Index vytvořte pomocí createIndex() během upgradeneeded; později ho v transakci získejte pomocí store.index(name). Index se automaticky aktualizuje spolu s úložištěm.

IDBIndex.getAll(query, count) vrací IDBRequest, nikoli Promise. Výsledkem je pole hodnot úložiště, nebo [], pokud nejsou žádné shody. query přijímá klíč indexu nebo IDBKeyRange; pokud ho vynecháte, odpovídají všechny položky. Volitelný parametr count omezuje počet výsledků. Pokud zadáte 0 nebo parametr vynecháte, vrátí se všechny odpovídající položky. Pořadí je vzestupné podle klíče indexu a poté podle primárního klíče.

IDBIndex.openCursor(query, direction) také vrací IDBRequest. V success přečtěte kurzor, nebo null, pokud už žádné výsledky nezbývají; continue() spustí další krok. cursor.key je klíč indexu, cursor.primaryKey klíč úložiště a cursor.value záznam. Výchozí směr je "next"; další možnosti jsou "prev", "nextunique" a "prevunique".

Kurzorem lze záznamy zpracovávat postupně; getAll() vytvoří celé pole výsledků. Požadavky zadávejte, dokud je transakce aktivní; nevkládejte mezi ně nesouvisející await. Příklad používá syntaxi IndexedDB 2.0 bez novější podoby možností getAll(). Ověřte cílový prohlížeč: samotná přítomnost Node 24 nedokazuje podporu tohoto Web API.

Příklady

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

Výsledek

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

Zobrazený kód a uvedený výsledek byly ověřeny v izolovaném prostředí metodou zaznamenanou v dokladu o ověření této přesné verze.

Zdroje