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

CKTIS / JavaScript

IDBObjectStore — úložiště záznamů IndexedDB

IDBObjectStore zpřístupňuje záznamy IndexedDB prostřednictvím odkazu vázaného na transakci. Umožňuje data přidávat, nahrazovat, číst, mazat a počítat a také používat sekundární indexy.

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 store = transaction.objectStore(name);
store.createIndex(name, keyPath, options); // upgrade transaction only
store.add(value, key); // key may be omitted
store.put(value, key); // key may be omitted
store.getAll(query, count); // query and count are optional
store.delete(query);
store.count(query); // query is optional
store.index(name);

IDBObjectStore je odkaz na úložiště záznamů IndexedDB vázaný na konkrétní transakci. Každý záznam má primární klíč a hodnotu kopírovanou pomocí strukturovaného klonování. keyPath: "id" získává klíč z pole id; při tomto nastavení nepředávejte metodám add() ani put() samostatný argument s klíčem.

add() vloží záznam; duplicitní klíč způsobí chybu ConstraintError. put() vloží záznam nebo nahradí celou hodnotu u existujícího klíče — pole neslučuje. delete(query) odstraní záznamy podle primárního klíče nebo rozsahu klíčů. Tyto operace vyžadují transakci, která povoluje zápis. getAll(query?, count?) načte hodnoty, ve výchozím nastavení seřazené podle vzestupného primárního klíče; count(query?) spočítá odpovídající záznamy. Pokud dotaz vynecháte, zahrne se celé úložiště.

createIndex(name, keyPath, options) vytváří index pouze během transakce pro aktualizaci schématu, obvykle v onupgradeneeded; unique: true vynucuje jedinečnost klíčů indexu. index(name) vrací existující IDBIndex pro vyhledávání podle sekundárního klíče. Obě metody vracejí odkazy synchronně; ostatní uvedené metody vracejí IDBRequest, nikoli Promise.

Úspěch požadavku neznamená potvrzení transakce: počkejte na complete a ošetřete abort. Zadávejte operace, dokud je transakce aktivní; čekání na nesouvisející asynchronní práci ji může zneaktivnit. Příklad používá podoby API z IndexedDB 2.0, bez novějšího přetížení getAll() s objektem možností. Jde o Web API, nikoli o součást ECMAScriptu; Node 24 nedokládá podporu v prohlížečích. Ověřte dostupnost indexedDB v cílovém prostředí.

Referenční identifikátory zahrnuté v tomto hesle: IDBObjectStore.createIndex, IDBObjectStore.add, IDBObjectStore.getAll, IDBObjectStore.delete, IDBObjectStore.put, IDBObjectStore.count, IDBObjectStore.index.

Příklady

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>IDBObjectStore: working with records</title>
</head>
<body>
  <h1>Working with an IndexedDB object store</h1>
  <script>
    (() => {
      const name = 'cktis-store-' + 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('items', { keyPath: 'id' });
        store.createIndex('byLabel', 'label', { unique: true });
      };
      opening.onsuccess = () => {
        const db = opening.result;
        if (!created) {
          db.close();
          console.log('Fixture name already in use');
          return;
        }
        const tx = db.transaction('items', 'readwrite');
        const store = tx.objectStore('items');
        store.add({ id: 1, label: 'draft' });
        store.add({ id: 2, label: 'spare' });
        store.put({ id: 1, label: 'final' });
        store.delete(2);
        const all = store.getAll();
        const count = store.count();
        const indexed = store.index('byLabel').get('final');
        const cleanup = () => {
          db.close();
          factory.deleteDatabase(name);
        };
        tx.oncomplete = () => {
          console.log(JSON.stringify({ items: all.result, count: count.result, indexedId: indexed.result.id }));
          cleanup();
        };
        tx.onabort = () => {
          report(tx.error);
          cleanup();
        };
      };
    })();
  </script>
</body>
</html>

Výsledek

Successful browser run (IndexedDB access permitted):
{"items":[{"id":1,"label":"final"}],"count":1,"indexedId":1}

If the browser blocks IndexedDB access with a SecurityError, as in the isolated environment:
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