WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

IndexedDB: Objektspeicher anlegen und Transaktionen öffnen

Mit `createObjectStore()` änderst du das Schema bei einem Versionswechsel; mit `transaction()` liest und schreibst du Datensätze in vorhandenen Objektspeichern.

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

Syntax

db.createObjectStore(name) → IDBObjectStore
db.createObjectStore(name, options) → IDBObjectStore

db.transaction(storeNames) → IDBTransaction
db.transaction(storeNames, mode) → IDBTransaction
db.transaction(storeNames, mode, options) → IDBTransaction

IDBDatabase steht für eine offene IndexedDB-Verbindung. db.createObjectStore(name, options) gibt sofort einen neuen IDBObjectStore zurück, funktioniert aber nur in einer aktiven versionchange-Transaktion. IndexedDB startet sie, wenn indexedDB.open() die Datenbank anlegt oder in einer höheren Version öffnet. Ändere das Schema in upgradeneeded. Eine offene Verbindung in einem anderen Tab kann das Upgrade blockieren: Die Öffnungsanfrage löst blocked aus, und die alte Verbindung kann auf versionchange mit close() reagieren.

Der optionale keyPath bestimmt, wo der Schlüssel im Wert steht, etwa in id. Ein Array von Pfaden ergibt einen zusammengesetzten Schlüssel; ohne Pfad wird der Schlüssel separat gespeichert. autoIncrement ist standardmäßig false; true aktiviert einen Schlüsselgenerator, lässt sich aber nicht mit einem leeren String oder einem Array als keyPath kombinieren (InvalidAccessError). Ein doppelter Speichername führt zu ConstraintError, ein ungültiger Schlüsselpfad zu SyntaxError und ein Aufruf ohne Upgrade-Transaktion zu InvalidStateError.

db.transaction(storeNames, mode, options) gibt sofort eine IDBTransaction zurück. Ihr Geltungsbereich wird durch einen einzelnen Speichernamen als String oder durch ein nicht leeres iterierbares Objekt mit Namen vorhandener Speicher festgelegt, etwa ein Array oder ein Set. tx.objectStore(name) liefert einen Speicher aus diesem Geltungsbereich. Standardmäßig erlaubt "readonly" nur Lesezugriffe; "readwrite" erlaubt auch Schreibzugriffe. "versionchange" ist hier nicht wählbar (TypeError). Ein unbekannter Speicher ergibt NotFoundError, eine leere Liste InvalidAccessError und eine gerade schließende oder geschlossene Verbindung InvalidStateError. Das optionale options.durability ("default", "strict", "relaxed") gibt einen Hinweis zur Dauerhaftigkeit beim Commit; prüfe die Browserunterstützung.

Erteile Anfragen nur, solange die Transaktion aktiv ist: in der Task, die sie erstellt hat, oder in einem success- oder error-Handler einer ihrer Anfragen. Nach await fetch(...) kann sie bereits automatisch abgeschlossen sein; eine spätere Anfrage kann TransactionInactiveError auslösen. Eine erfolgreiche Anfrage bedeutet nicht, dass die ganze Transaktion erfolgreich war. complete bestätigt den Commit; abort bedeutet, dass Änderungen zurückgenommen wurden.

IndexedDB ist eine Web-API und kein Teil von ECMAScript 2024. Der Zugriff ist auf denselben Origin beschränkt. Browsereinstellungen können den Speicherzugriff oder die Aufbewahrungsdauer begrenzen.

Beispiele

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>IndexedDB example</title>
</head>
<body>
<script>
(async () => {
  const idb = window.indexedDB;
  const name = `cktis-notes-${crypto.randomUUID()}`;
  const requestResult = (request) => new Promise((resolve, reject) => {
    request.onsuccess = () => resolve(request.result);
    request.onerror = () => reject(request.error);
  });
  const finished = (tx) => new Promise((resolve, reject) => {
    tx.oncomplete = () => resolve();
    tx.onabort = () => reject(tx.error ?? new Error("Transaction aborted"));
  });

  const open = idb.open(name, 1);
  open.onupgradeneeded = () => {
    open.result.createObjectStore("notes", { keyPath: "id" });
  };
  const db = await requestResult(open);
  db.onversionchange = () => db.close();

  let title;
  try {
    const write = db.transaction("notes", "readwrite");
    write.objectStore("notes").put({ id: 1, title: "IndexedDB" });
    await finished(write);

    const read = db.transaction("notes");
    const get = read.objectStore("notes").get(1);
    await finished(read);
    title = get.result.title;
  } finally {
    db.close();
    await requestResult(idb.deleteDatabase(name));
  }
  console.log(title);
})().catch((error) => console.error(error));
</script>
</body>
</html>

Ergebnis

IndexedDB

Stelle die HTML-Datei über HTTPS bereit und öffne sie in einem Browser, der Speicherzugriff erlaubt. Das Beispiel legt eine Datenbank mit zufälligem Namen an, liest nach dem Commit der Schreibtransaktion, schließt und löscht die Datenbank und gibt dann `IndexedDB` in der Browserkonsole aus.

Zugehörige Lektionen

  • JavaScript · Lektion 31 · Fortgeschritten · Version: 4

Quellen