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

CKTIS / JavaScript

Události transakce IndexedDB: complete, abort a error

Pomocí `complete` a `abort` zjistíte výsledek celé transakce IndexedDB, zatímco `error` pomáhá určit příčinu selhání jednotlivého požadavku.

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

Syntaxe

tx.addEventListener("complete", onComplete);
tx.addEventListener("abort", onAbort);
tx.addEventListener("error", onRequestError);

// Property-based alternatives:
tx.oncomplete = onComplete;
tx.onabort = onAbort;
tx.onerror = onRequestError;

// Read the transaction's error, if any:
const failure = tx.error;

// To explicitly roll back a transaction that can still be aborted:
tx.abort();

Události complete, abort a error sledujte na transakci tx pomocí addEventListener() nebo vlastností oncomplete, onabort a onerror. complete znamená, že byla potvrzena celá transakce. Událost success u jednotlivého požadavku nestačí: pozdější selhání ještě může vrátit jeho změny zpět. Potvrzení nemusí znamenat fyzický zápis dat na disk; záleží na nastavení trvanlivosti a běhovém prostředí.

abort znamená, že transakce skončila bez potvrzení a její změny byly vráceny zpět. Událost probublává až k IDBDatabase a nelze ji zrušit. Může následovat po výslovném volání tx.abort() nebo po selhání. V obsluze abort přečtěte tx.error: tato vlastnost pouze pro čtení obsahuje DOMException s popisem selhání nebo null, například po výslovném volání tx.abort().

Událost error vzniká na IDBRequest a probublává přes tx až k databázi. Příčinu selhání požadavku čtěte z event.target.error, ne z tx.error, které ještě může být null. Ve výchozím stavu chyba požadavku ukončí transakci. U očekávané chyby zavolejte v její obsluze event.preventDefault(), abyste zabránili právě tomuto ukončení; samotné stopPropagation() nestačí. Požadavek i tak selhal. Konečný výsledek transakce určujte podle complete nebo abort.

IndexedDB je API webové platformy, nikoli součást ECMAScript 2024. Přidávejte požadavky, dokud je transakce aktivní, například hned po vytvoření nebo v obsluze jejích požadavků. Po čekání na nezávislou operaci, jako je fetch(), už transakce požadavky přijímat nemusí. Dostupnost závisí na běhovém prostředí a pravidlech přístupu k úložišti.

Příklady

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>IndexedDB transaction events</title>
</head>
<body>
<pre id="output"></pre>
<script>
void (async () => {
  const output = document.getElementById("output");
  function log(line) {
    console.log(line);
    output.textContent += `${line}\n`;
  }

  const name = `cktis-tx-${Date.now()}-${Math.random().toString(36).slice(2)}`;
  const indexedDB = window.indexedDB;
  const open = indexedDB.open(name, 1);
  open.onupgradeneeded = () => open.result.createObjectStore("items");
  const db = await new Promise((resolve, reject) => {
    open.onsuccess = () => resolve(open.result);
    open.onerror = () => reject(open.error);
  });

  function write(label, cancelError) {
    return new Promise((resolve) => {
      const tx = db.transaction("items", "readwrite");
      tx.oncomplete = () => resolve("complete");
      tx.onabort = () => resolve(`abort: ${tx.error?.name ?? "no error"}`);
      tx.onerror = (event) => {
        log(`${label} error: ${event.target.error.name}`);
      };

      const items = tx.objectStore("items");
      items.add("first", label);
      const duplicate = items.add("second", label);
      if (cancelError) {
        duplicate.onerror = (event) => {
          if (duplicate.error.name === "ConstraintError") event.preventDefault();
        };
      }
    });
  }

  try {
    for (const [label, cancelError] of [["rollback", false], ["recover", true]]) {
      log(`${label} ${await write(label, cancelError)}`);
    }

    const values = await new Promise((resolve, reject) => {
      const tx = db.transaction("items", "readonly");
      const items = tx.objectStore("items");
      const rolledBack = items.get("rollback");
      const recovered = items.get("recover");
      tx.oncomplete = () => resolve([rolledBack.result, recovered.result]);
      tx.onabort = () => reject(tx.error ?? new Error("Read aborted"));
    });
    log(`stored: ${values.map(String).join(",")}`);
  } finally {
    db.close();
    await new Promise((resolve, reject) => {
      const deletion = indexedDB.deleteDatabase(name);
      deletion.onsuccess = () => resolve();
      deletion.onerror = () => reject(deletion.error);
    });
  }
})().catch(console.error);
</script>
</body>
</html>

Výsledek

rollback error: ConstraintError
rollback abort: ConstraintError
recover error: ConstraintError
recover complete
stored: undefined,first

Zpřístupněte příklad jako stránku HTML přes HTTPS a otevřete ji v prohlížeči, ve kterém je IndexedDB dostupné a ukládání dat povolené. Obě transakce ohlásí `ConstraintError` kvůli duplicitnímu klíči. První vrátí počáteční zápis zpět; druhá ho potvrdí, protože obsluha chyby zabrání výchozí akci.

Související lekce

  • JavaScript · Lekce 20 · Středně pokročilá · Verze: 3
  • JavaScript · Lekce 21 · Středně pokročilá · Verze: 3

Zdroje