CKTIS / JavaScript
IndexedDB-transactiegebeurtenissen: complete, abort en error
Gebruik `complete` en `abort` voor de uitkomst van de hele IndexedDB-transactie en `error` om te achterhalen waarom een afzonderlijk verzoek is mislukt.
Versie: 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();Luister op transactie tx naar complete, abort en error met addEventListener() of de eigenschappen oncomplete, onabort en onerror. complete betekent dat de hele transactie is vastgelegd. success voor één verzoek is daarvoor niet genoeg: een latere fout kan de wijzigingen van dat verzoek nog terugdraaien. Vastleggen betekent niet altijd dat de gegevens al fysiek naar schijf zijn geschreven; dat hangt af van de duurzaamheidsinstelling en de uitvoeringsomgeving.
abort betekent dat de transactie is beëindigd zonder te zijn vastgelegd en dat de wijzigingen zijn teruggedraaid. De gebeurtenis bubbelt naar IDBDatabase en is niet annuleerbaar. Ze kan volgen op een expliciete aanroep van tx.abort() of op een fout. Lees in de abort-handler tx.error: deze alleen-lezen eigenschap bevat een DOMException met de oorzaak van de fout of null, bijvoorbeeld na een expliciete tx.abort().
Een error-gebeurtenis ontstaat op een IDBRequest en bubbelt via tx naar de database. Lees event.target.error voor de oorzaak van de verzoekfout, niet tx.error, dat nog null kan zijn. Standaard breekt een verzoekfout de transactie af. Roep bij een verwachte fout in de handler event.preventDefault() aan om juist die afbreking te voorkomen; stopPropagation() alleen is niet genoeg. Het verzoek is nog steeds mislukt. Gebruik complete of abort voor de uiteindelijke uitkomst van de transactie.
IndexedDB is een API van het webplatform en geen onderdeel van ECMAScript 2024. Voeg verzoeken toe terwijl de transactie actief is, bijvoorbeeld meteen na het aanmaken of in de handlers van haar verzoeken. Na het wachten op een onafhankelijke operatie zoals fetch() kan de transactie mogelijk geen verzoeken meer aannemen. De beschikbaarheid hangt af van de uitvoeringsomgeving en het opslagbeleid.
Voorbeelden
<!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>Resultaat
rollback error: ConstraintError rollback abort: ConstraintError recover error: ConstraintError recover complete stored: undefined,first
Bied het voorbeeld via HTTPS aan als HTML-pagina en open die in een browser waarin IndexedDB beschikbaar is en gegevensopslag is toegestaan. Beide transacties melden `ConstraintError` vanwege een dubbele sleutel. De eerste draait de oorspronkelijke schrijfactie terug; de tweede legt die vast doordat de fouthandler de standaardactie voorkomt.
Gerelateerde lessen
- JavaScript · Les 20 · Gemiddeld · Versie: 3
- JavaScript · Les 21 · Gemiddeld · Versie: 3