KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

IndexedDB: een index maken, een record invoegen en zoeken via de index

Maak een secundaire index bij een database-upgrade, voeg een record in zonder te overschrijven en zoek op indexsleutel in plaats van op primaire sleutel.

Versie: Current web platform; runtime support varies

Syntax

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

createIndex(), add() en index() zijn instantiemethoden van IDBObjectStore in de IndexedDB-web-API, geen onderdeel van ECMAScript. IndexedDB volgt het same-originbeleid; de beschikbaarheid hangt af van de runtime en de opslaginstellingen van de browser.

store.createIndex(name, keyPath, options) retourneert meteen een IDBIndex, maar de schemawijziging is pas definitief als de transactie is vastgelegd. Roep de methode aan in een actieve versionchange-transactie, meestal in upgradeneeded bij het aanmaken van de database of het verhogen van de versie. De naam identificeert de index; het sleutelpad bepaalt de indexsleutel aan de hand van het record, zonder een veld toe te voegen. IndexedDB indexeert bestaande records en houdt de index automatisch bij.

unique en multiEntry zijn standaard false. unique: true verbiedt gelijke indexsleutels in verschillende records; bestaande duplicaten kunnen de upgrade afbreken. multiEntry: true indexeert de geldige elementen van een array afzonderlijk in plaats van de hele array als één sleutel te gebruiken. Dit kan niet samen met een array van sleutelpaden voor een samengestelde sleutel (InvalidAccessError). Een dubbele indexnaam veroorzaakt meteen ConstraintError.

store.add(value[, key]) voegt een gestructureerde kloon in zonder iets te overschrijven. Gebruik een actieve readwrite- of versionchange-transactie. Laat key weg als de primaire sleutel in de waarde staat; geef hem op als de sleutel los van de waarde staat en er geen generator is. Bij succes bevat IDBRequest.result de primaire sleutel, maar alleen het complete-event van de transactie bevestigt dat de wijziging is vastgelegd. Een dubbele primaire sleutel of sleutel van een unieke index laat het verzoek mislukken met ConstraintError. put() kan een record vervangen, maar moet ook de uniciteit van de index respecteren.

store.index(name) geeft de bestaande IDBIndex terug, gebonden aan dezelfde transactie. Het maakt geen index en leest geen record. Een onbekende naam geeft NotFoundError; namen zijn hoofdlettergevoelig. In een actieve transactie vraagt index.get(key) het eerste passende record op aan de hand van de indexsleutel, niet de primaire sleutel. Gebruik het indexobject niet meer om te lezen nadat de transactie is afgelopen.

Voorbeelden

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

Resultaat

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

Bied het HTML-bestand aan via een vertrouwd HTTPS-adres en open het in een browser met toegang tot IndexedDB en `crypto.randomUUID()`. Het voorbeeld maakt een aparte database, zoekt op `email` nadat de schrijfbewerking is vastgelegd, en sluit en verwijdert de database voordat het resultaat in de browserconsole verschijnt.

Gerelateerde lessen

  • JavaScript · Les 31 · Gevorderd · Versie: 4

Bronnen