WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

IndexedDB: Index anlegen, Datensätze einfügen, zählen und lesen

Lege einen Sekundärindex an, füge Datensätze ohne Überschreiben ein und frage sie nach Primär- oder Indexschlüssel ab.

Version: ECMAScript 2024 and the current web platform; runtime support varies

Syntax

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)

Ein IDBObjectStore ist ein an eine Transaktion gebundener Objektspeicher. Jeder Datensatz hat einen Primärschlüssel und einen Wert. IndexedDB ist eine Web-API, kein Teil von ECMAScript. Für den Datenbankzugriff gilt die Same-Origin-Policy.

createIndex(name, keyPath, options) gibt sofort einen IDBIndex zurück, ist aber nur in einer aktiven versionchange-Transaktion erlaubt, meist in upgradeneeded. Der Schlüsselpfad bestimmt, woher der Indexschlüssel stammt; er fügt dem Datensatz kein Feld hinzu. unique: true verbietet doppelte Indexschlüssel, multiEntry: true indexiert gültige Array-Elemente einzeln. Beide Optionen sind standardmäßig false. multiEntry: true ist mit einem zusammengesetzten Schlüsselpfad in Form eines Arrays von Pfaden nicht kombinierbar.

add(value, key) speichert eine strukturierte Kopie; in request.result steht der neue Schlüssel. Lass das zweite Argument bei einem im Wert enthaltenen Schlüssel weg. Bei einem separat gespeicherten Schlüssel ohne Schlüsselgenerator musst du es angeben. Ein doppelter Primärschlüssel oder die Verletzung eines eindeutigen Indexes führt zum Anfragefehler ConstraintError. Mit put() kannst du nach Primärschlüssel einfügen oder ersetzen.

count(query) liefert eine Zahl, getAll(query, count) ein Array kopierter Werte, das ohne Treffer leer ist. Beide akzeptieren einen Primärschlüssel oder IDBKeyRange und berücksichtigen ohne Filter den gesamten Speicher. Ein positiver count begrenzt die Anzahl der Werte aus getAll(). Standardmäßig ist die Reihenfolge nach Primärschlüssel aufsteigend. Die neuere Form getAll({ query, count, direction }) erlaubt etwa "prev"; prüfe die Unterstützung im Zielbrowser.

index(name) liefert sofort einen vorhandenen IDBIndex derselben Transaktion. Ein unbekannter Name löst NotFoundError aus; Groß- und Kleinschreibung zählen. store.getAll("sci-fi") sucht nach dem Primärschlüssel; store.index("byGenre").getAll("sci-fi") liefert Datensatzwerte anhand des Indexschlüssels.

add(), count() und getAll() geben ein IDBRequest-Objekt zurück, kein Promise. Lies result nach success und behandle error. In einer gewöhnlichen Transaktion erfordern Schreibzugriffe readwrite. Stelle Anfragen, solange die Transaktion aktiv ist: Beim Warten auf andere asynchrone Arbeit kann sie enden. Eine erfolgreiche Anfrage bestätigt noch keinen Commit; warte dafür auf complete der Transaktion.

Beispiele

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

Ergebnis

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

Stelle das HTML-Dokument über HTTPS bereit, öffne es im Browser und schau in die Entwicklerkonsole. Das Beispiel legt eine separate temporäre Datenbank an und löscht sie danach. Es fügt drei Bücher nicht nach Primärschlüssel sortiert ein und gibt nach dem Commit alle Titel nach `id` sowie die über den Genreindex ausgewählten Titel aus.

Zugehörige Lektionen

  • JavaScript · Lektion 21 · Mittlere Stufe · Version: 3

Quellen