База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / JavaScript

Събития на транзакциите в IndexedDB: complete, abort и error

Използвай `complete` и `abort`, за да определиш резултата от цялата транзакция в IndexedDB, а `error` — за да разбереш защо отделна заявка е неуспешна.

Версия: ECMAScript 2024 and the current web platform; runtime support varies

Синтаксис

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

Слушай за complete, abort и error върху транзакцията tx чрез addEventListener() или свойствата oncomplete, onabort и onerror. complete означава, че цялата транзакция е потвърдена. Събитието success на отделна заявка не е достатъчно: по-късна грешка все още може да отмени промените от нея. Потвърждаването невинаги означава, че данните вече са физически записани на диска; това зависи от настройката за трайност и средата за изпълнение.

abort означава, че транзакцията е приключила без потвърждаване и промените ѝ са отменени. Събитието се разпространява нагоре до IDBDatabase и не може да се отмени. Може да последва явно извикване на tx.abort() или грешка. В обработчика на abort прочети tx.error: това свойство само за четене съдържа DOMException с описание на грешката или null, например след явно извикване на tx.abort().

Събитието error възниква върху IDBRequest и се разпространява през tx до базата данни. Прочети причината за грешката на заявката от event.target.error, а не от tx.error, което все още може да е null. По подразбиране грешката на заявка прекратява транзакцията. При очаквана грешка извикай event.preventDefault() в обработчика, за да предотвратиш точно това прекратяване; само stopPropagation() не е достатъчно. Заявката остава неуспешна. Определи крайния резултат от транзакцията чрез complete или abort.

IndexedDB е API на уеб платформата, а не част от ECMAScript 2024. Добавяй заявки, докато транзакцията е активна — например веднага след създаването ѝ или в обработчиците на нейните заявки. След изчакване на независима операция като fetch() транзакцията може вече да не приема заявки. Наличността зависи от средата за изпълнение и правилата за съхранение.

Примери

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

Резултат

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

Предостави примера като HTML страница през HTTPS и я отвори в браузър, в който IndexedDB е достъпна и съхраняването на данни е разрешено. И двете транзакции съобщават `ConstraintError` за дублиран ключ. Първата отменя първоначалния запис, а втората го потвърждава, защото обработчикът на грешката предотвратява действието по подразбиране.

Свързани уроци

  • JavaScript · Урок 20 · Средно · Версия: 3
  • JavaScript · Урок 21 · Средно · Версия: 3

Източници