Znalostná bázaCentrum skúšok
SKSlovenčina
Vybrať jazyk13

CKTIS / JavaScript

Udalosti transakcie IndexedDB: complete, abort a error

Pomocou `complete` a `abort` zistite výsledok celej transakcie IndexedDB a pomocou `error` zistite príčinu zlyhania jednotlivej požiadavky.

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

Syntax

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();

Udalosti complete, abort a error sledujte na transakcii tx pomocou addEventListener() alebo vlastností oncomplete, onabort a onerror. complete znamená, že bola potvrdená celá transakcia. Udalosť success jednotlivej požiadavky nestačí: neskoršie zlyhanie ešte môže vrátiť jej zmeny späť. Potvrdenie nemusí znamenať fyzický zápis údajov na disk; závisí to od nastavenia trvácnosti a prostredia vykonávania.

abort znamená, že sa transakcia skončila bez potvrdenia a jej zmeny sa vrátili späť. Udalosť prebubláva až k IDBDatabase a nemožno ju zrušiť. Môže nasledovať po výslovnom volaní tx.abort() alebo po zlyhaní. V obsluhe abort prečítajte tx.error: táto vlastnosť iba na čítanie obsahuje DOMException s opisom zlyhania alebo null, napríklad po výslovnom volaní tx.abort().

Udalosť error vzniká na IDBRequest a prebubláva cez tx až k databáze. Príčinu zlyhania požiadavky čítajte z event.target.error, nie z tx.error, ktoré ešte môže byť null. Predvolene chyba požiadavky ukončí transakciu. Pri očakávanej chybe zavolajte v jej obsluhe event.preventDefault(), aby ste zabránili práve tomuto ukončeniu; samotné stopPropagation() nestačí. Požiadavka aj tak zlyhala. Konečný výsledok transakcie určujte podľa complete alebo abort.

IndexedDB je API webovej platformy, nie súčasť ECMAScript 2024. Pridávajte požiadavky, kým je transakcia aktívna, napríklad hneď po vytvorení alebo v obsluhe jej požiadaviek. Po čakaní na nezávislú operáciu, ako je fetch(), už transakcia nemusí prijímať požiadavky. Dostupnosť závisí od prostredia vykonávania a pravidiel prístupu k úložisku.

Prí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ýsledok

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

Sprístupnite príklad ako stránku HTML cez HTTPS a otvorte ju v prehliadači, v ktorom je IndexedDB dostupné a ukladanie údajov povolené. Obe transakcie ohlásia `ConstraintError` pre duplicitný kľúč. Prvá vráti počiatočný zápis späť; druhá ho potvrdí, pretože obsluha chyby zabráni predvolenej akcii.

Súvisiace lekcie

  • JavaScript · Lekcia 20 · Stredne pokročilá · Verzia: 3
  • JavaScript · Lekcia 21 · Stredne pokročilá · Verzia: 3

Zdroje