Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / JavaScript

Dogodki transakcij IndexedDB: complete, abort in error

Z dogodkoma `complete` in `abort` ugotovi izid celotne transakcije IndexedDB, z dogodkom `error` pa vzrok neuspeha posamezne zahteve.

Različica: ECMAScript 2024 and the current web platform; runtime support varies

Sintaksa

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

Na transakciji tx poslušaj dogodke complete, abort in error z addEventListener() ali prek lastnosti oncomplete, onabort in onerror. complete pomeni, da je bila potrjena celotna transakcija. Dogodek success posamezne zahteve ne zadošča: poznejša napaka lahko še vedno razveljavi njene spremembe. Potrditev ne pomeni nujno, da so podatki že fizično zapisani na disk; to je odvisno od nastavitve trajnosti in izvajalnega okolja.

abort pomeni, da se je transakcija končala brez potrditve in da so bile njene spremembe razveljavljene. Dogodek se širi navzgor do IDBDatabase in ni preklicljiv. Lahko sledi izrecnemu klicu tx.abort() ali napaki. V obdelovalniku dogodka abort preberi tx.error: ta lastnost samo za branje vsebuje DOMException z opisom napake ali null, na primer po izrecnem klicu tx.abort().

Dogodek error nastane na IDBRequest in se prek tx širi do podatkovne zbirke. Vzrok napake zahteve preberi iz event.target.error, ne iz tx.error, ki je morda še vedno null. Privzeto napaka zahteve prekine transakcijo. Pri pričakovani napaki v obdelovalniku pokliči event.preventDefault(), da preprečiš prav to prekinitev; samo stopPropagation() ne zadošča. Zahteva je kljub temu neuspešna. Končni izid transakcije ugotovi z dogodkom complete ali abort.

IndexedDB je API spletne platforme, ne del ECMAScript 2024. Dodajaj zahteve, dokler je transakcija aktivna, na primer takoj po ustvarjanju ali v obdelovalnikih njenih zahtev. Po čakanju na neodvisno operacijo, kot je fetch(), transakcija morda ne sprejema več zahtev. Razpoložljivost je odvisna od izvajalnega okolja in pravil shranjevanja.

Primeri

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

Rezultat

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

Primer ponudi kot stran HTML prek HTTPS in jo odpri v brskalniku, kjer je IndexedDB na voljo in je shranjevanje podatkov dovoljeno. Obe transakciji javita `ConstraintError` zaradi podvojenega ključa. Prva razveljavi začetni zapis, druga pa ga potrdi, ker obdelovalnik napake prepreči privzeto dejanje.

Povezane lekcije

  • JavaScript · Lekcija 20 · Srednja · Različica: 3
  • JavaScript · Lekcija 21 · Srednja · Različica: 3

Viri