Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / JavaScript

Zdarzenia complete, abort i error transakcji IndexedDB

Używaj `complete` i `abort`, aby ustalić wynik całej transakcji IndexedDB, a `error`, aby rozpoznać błąd pojedynczego żądania.

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

Składnia

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

Nasłuchuj zdarzeń complete, abort i error na obiekcie transakcji tx za pomocą addEventListener() lub właściwości oncomplete, onabort i onerror. complete oznacza, że cała transakcja została zatwierdzona. success pojedynczego żądania tego nie gwarantuje: późniejszy błąd może wycofać również tę zmianę. Zatwierdzenie nie musi oznaczać fizycznego zapisu danych na dysku; zależy to od ustawienia trwałości i środowiska.

abort oznacza zakończenie transakcji bez zatwierdzenia i wycofanie jej zmian. Zdarzenie propaguje się do IDBDatabase i nie można anulować jego domyślnej akcji. Może wystąpić po wywołaniu tx.abort() lub wskutek błędu. W obsłudze abort odczytaj tx.error: ta właściwość tylko do odczytu zawiera DOMException opisujący przyczynę błędu albo null, np. po jawnym tx.abort().

Zdarzenie error pochodzi z IDBRequest i propaguje się przez tx do bazy danych. Przyczynę błędu żądania odczytaj z event.target.error, a nie z tx.error, które może jeszcze być null. Domyślnie błąd żądania przerywa transakcję. Dla oczekiwanego błędu wywołaj event.preventDefault() podczas jego obsługi, aby zapobiec temu konkretnemu przerwaniu; samo stopPropagation() nie wystarczy. Żądanie nadal kończy się błędem. Wynik całej transakcji ustal na podstawie complete lub abort.

IndexedDB to API platformy webowej, a nie część ECMAScript 2024. Dodawaj żądania, gdy transakcja jest aktywna, np. bezpośrednio po jej utworzeniu lub w obsłudze jej żądań. Po oczekiwaniu na niezależną operację, np. fetch(), transakcja może już nie przyjmować żądań. Dostępność zależy od środowiska i zasad dostępu do pamięci.

Przykłady

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

Wynik

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

Udostępnij przykład jako stronę HTML przez HTTPS i otwórz ją w przeglądarce, w której IndexedDB jest dostępne i można zapisywać dane. Obie transakcje zgłaszają `ConstraintError` z powodu powtórzonego klucza. Pierwsza wycofuje początkowy zapis, a druga go zatwierdza, ponieważ obsługa błędu anuluje domyślną akcję.

Powiązane lekcje

  • JavaScript · Lekcja 20 · Średniozaawansowany · Wersja: 3
  • JavaScript · Lekcja 21 · Średniozaawansowany · Wersja: 3

Źródła