Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / JavaScript

IndexedDB: ustvarjanje indeksa, dodajanje, štetje in branje zapisov

Ustvari sekundarni indeks, vstavljaj zapise brez prepisovanja ter išči po primarnem ključu ali ključu indeksa.

Različica: ECMAScript 2024 and the current web platform; runtime support varies

Sintaksa

store.createIndex(name, keyPath)
store.createIndex(name, keyPath, options)
store.count()
store.count(query)
store.add(value)
store.add(value, key)
store.getAll()
store.getAll(query)
store.getAll(query, count)
store.getAll(options)
store.index(name)

IDBObjectStore predstavlja shrambo objektov, vezano na transakcijo. Vsak zapis ima primarni ključ in vrednost. IndexedDB je spletni API, ne del standarda ECMAScript; dostop upošteva pravilnik istega izvora.

createIndex(name, keyPath, options) takoj vrne IDBIndex, vendar ga je mogoče klicati le v aktivni transakciji versionchange, običajno v obravnavi dogodka upgradeneeded. Pot do ključa določa, od kod se pridobi ključ indeksa; zapisu ne doda polja. unique: true prepove podvojene ključe indeksa, multiEntry: true pa indeksira veljavne elemente polja posamično. Obe možnosti sta privzeto false. multiEntry: true ni združljiv s sestavljeno potjo do ključa, podano kot polje poti.

add(value, key) shrani strukturirano kopijo in novi ključ poda v request.result. Drugi argument izpusti, če je ključ v vrednosti; podaj ga, če je ključ ločen in ni generatorja. Podvojen primarni ključ ali kršitev enoličnosti indeksa povzroči napako zahteve ConstraintError. Za vstavljanje ali zamenjavo po primarnem ključu uporabi put().

count(query) poda število, getAll(query, count) pa polje kopij vrednosti, ki je brez zadetkov prazno. Obe metodi sprejmeta primarni ključ ali IDBKeyRange in brez filtra zajameta celotno shrambo. Pozitivni count omeji število vrednosti iz getAll(). Privzeti vrstni red je naraščajoč po primarnem ključu. Novejša oblika getAll({ query, count, direction }) omogoča na primer "prev"; preveri podporo v ciljnem brskalniku.

index(name) takoj vrne obstoječi IDBIndex iz iste transakcije. Neznano ime sproži NotFoundError; male in velike črke se razlikujejo. store.getAll("sci-fi") išče po primarnem ključu, store.index("byGenre").getAll("sci-fi") pa vrne vrednosti zapisov, ki ustrezajo ključu indeksa.

add(), count() in getAll() vrnejo IDBRequest, ne Promise. Preberi result po success in obravnavaj error. Za pisanje v običajni transakciji je potreben način readwrite. Zahteve dodajaj, dokler je transakcija aktivna: med čakanjem na drugo asinhrono opravilo se lahko konča. Uspešna zahteva še ne potrdi transakcije; počakaj na njen dogodek complete.

Primeri

<!doctype html>
<meta charset="utf-8">
<title>IndexedDB object store methods</title>
<script>
(() => {
  const dbName = `cktis-books-${crypto.randomUUID()}`;
  const open = indexedDB.open(dbName, 1);

  open.onupgradeneeded = () => {
    const store = open.result.createObjectStore('books', { keyPath: 'id' });
    store.createIndex('byGenre', 'genre');
  };
  open.onerror = () => console.error(open.error);

  open.onsuccess = () => {
    const db = open.result;
    const tx = db.transaction('books', 'readwrite');
    const store = tx.objectStore('books');

    const cleanup = () => {
      db.close();
      const deletion = indexedDB.deleteDatabase(dbName);
      deletion.onerror = () => console.error(deletion.error);
    };
    tx.onabort = () => {
      console.error(tx.error);
      cleanup();
    };

    const added = store.add({ id: 3, title: 'Orbit', genre: 'sci-fi' });
    store.add({ id: 1, title: 'Dunes', genre: 'sci-fi' });
    store.add({ id: 2, title: 'Herbs', genre: 'guide' });
    const total = store.count();
    const all = store.getAll();
    const matches = store.index('byGenre').getAll('sci-fi');

    tx.oncomplete = () => {
      const titles = (request) => request.result.map((book) => book.title).join(', ');
      console.log(`Added key: ${added.result}`);
      console.log(`Total: ${total.result}`);
      console.log(`All: ${titles(all)}`);
      console.log(`Sci-fi: ${titles(matches)}`);
      cleanup();
    };
  };
})();
</script>

Rezultat

Added key: 3
Total: 3
All: Dunes, Herbs, Orbit
Sci-fi: Dunes, Orbit

Dokument HTML ponudi prek HTTPS, odpri ga v brskalniku in si oglej razvijalsko konzolo. Primer ustvari ločeno začasno podatkovno zbirko in jo nato izbriše. Vstavi tri knjige v drugačnem vrstnem redu od primarnih ključev, po potrditvi transakcije pa izpiše vse naslove po `id` in naslove, izbrane z indeksom žanra.

Povezane lekcije

  • JavaScript · Lekcija 21 · Srednja · Različica: 3

Viri