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

CKTIS / JavaScript

IndexedDB: vytvoření indexu, vložení záznamu a vyhledání přes index

Při změně verze databáze vytvořte sekundární index, vložte záznam bez přepsání a vyhledejte ho podle klíče indexu místo primárního klíče.

Verze: Current web platform; runtime support varies

Syntaxe

store.createIndex(name, keyPath)
store.createIndex(name, keyPath, { unique, multiEntry })
store.add(value)
store.add(value, key)
store.index(name)

createIndex(), add() a index() jsou instanční metody IDBObjectStore ve webovém API IndexedDB, nikoli součást ECMAScriptu. IndexedDB dodržuje zásadu stejného původu; dostupnost závisí na běhovém prostředí a nastavení úložiště v prohlížeči.

store.createIndex(name, keyPath, options) ihned vrací IDBIndex, změna schématu se však uloží až po potvrzení transakce. Metodu volejte v aktivní transakci versionchange, obvykle při obsluze upgradeneeded při založení databáze nebo zvýšení její verze. Název identifikuje index; cesta ke klíči určuje, odkud se ze záznamu získá klíč indexu, aniž by se přidalo pole. IndexedDB indexuje existující záznamy a index automaticky aktualizuje.

Výchozí hodnota unique i multiEntry je false. unique: true zakazuje shodné klíče indexu v různých záznamech; existující duplicity mohou přerušit změnu verze. multiEntry: true indexuje jednotlivé platné prvky pole místo celého pole jako jediného klíče. Tuto volbu nelze kombinovat s polem cest ke složenému klíči (InvalidAccessError). Duplicitní název indexu ihned vyvolá ConstraintError.

store.add(value[, key]) vkládá strukturovanou kopii bez přepsání. Vyžaduje aktivní transakci readwrite nebo versionchange. Pokud je primární klíč součástí hodnoty, key vynechte; u klíče mimo hodnotu bez generátoru jej zadejte. Při úspěchu obsahuje IDBRequest.result primární klíč, ale potvrzení transakce oznamuje až její událost complete. Duplicitní primární klíč nebo klíč jedinečného indexu způsobí selhání požadavku s ConstraintError. put() může záznam nahradit, ale také musí dodržet jedinečnost indexu.

store.index(name) vrací existující IDBIndex vázaný na tutéž transakci. Nevytváří index ani nečte záznam. Neexistující název vyvolá NotFoundError; rozlišují se velká a malá písmena. V aktivní transakci index.get(key) vyžádá první odpovídající záznam podle klíče indexu, nikoli primárního klíče. Po skončení transakce už tento objekt k dalšímu čtení nepoužívejte.

Příklady

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>IndexedDB: insert and look up a contact</title>
</head>
<body>
<script>
(async () => {
  const { indexedDB, crypto } = window;
  const name = `cktis-index-${crypto.randomUUID()}`;
  const resultOf = (request) => new Promise((resolve, reject) => {
    request.onsuccess = () => resolve(request.result);
    request.onerror = () => reject(request.error);
  });
  const committed = (tx) => new Promise((resolve, reject) => {
    tx.oncomplete = () => resolve();
    tx.onabort = () => reject(tx.error ?? new Error('Transaction aborted'));
  });

  const open = indexedDB.open(name, 1);
  open.onupgradeneeded = () => {
    const store = open.result.createObjectStore('contacts', { keyPath: 'id' });
    store.createIndex('byEmail', 'email', { unique: true });
  };
  const db = await resultOf(open);
  let contact;
  try {
    const write = db.transaction('contacts', 'readwrite');
    write.objectStore('contacts').add({ id: 7, email: 'ada@example.test' });
    await committed(write);

    const read = db.transaction('contacts', 'readonly');
    const lookup = read.objectStore('contacts').index('byEmail').get('ada@example.test');
    await committed(read);
    contact = lookup.result;
  } finally {
    db.close();
    await resultOf(indexedDB.deleteDatabase(name));
  }
  console.log(JSON.stringify(contact));
})().catch((error) => console.error(error));
</script>
</body>
</html>

Výsledek

{"id":7,"email":"ada@example.test"}

Zpřístupněte soubor HTML na důvěryhodné adrese HTTPS a otevřete ho v prohlížeči s dostupnými IndexedDB a `crypto.randomUUID()`. Příklad vytvoří samostatnou databázi, po potvrzení zápisu vyhledá záznam podle `email` a před výpisem výsledku do konzole prohlížeče databázi zavře a odstraní.

Související lekce

  • JavaScript · Lekce 31 · Pokročilá · Verze: 4

Zdroje