CKTIS / JavaScript
Odpiranje IndexedDB: upgradeneeded, blocked, success in error
Prepoznaj, kdaj zahteva za odpiranje IndexedDB potrebuje nadgradnjo sheme, čaka na zaprtje povezave, uspe ali spodleti.
Različica: ECMAScript 2024 and the current web platform; runtime support varies
Sintaksa
const request = indexedDB.open(name); // or indexedDB.open(name, version)
request.addEventListener("upgradeneeded", onUpgradeNeeded);
request.addEventListener("blocked", onBlocked);
request.addEventListener("success", onSuccess);
request.addEventListener("error", onError);
// Alternatively, assign one handler to each property:
request.onupgradeneeded = onUpgradeNeeded;
request.onblocked = onBlocked;
request.onsuccess = onSuccess;
request.onerror = onError;indexedDB.open(name, version) takoj vrne IDBOpenDBRequest, ne pa Promise. Odpiranje poteka asinhrono. upgradeneeded in blocked pripadata IDBOpenDBRequest; success in error sta podedovana iz IDBRequest. Če izpustiš version, se odpre obstoječa različica ali se ustvari zbirka v različici 1. IndexedDB je API spletne platforme, ne del ECMAScripta; dostop je odvisen od izvajalnega okolja in nastavitev shrambe.
upgradeneeded se sproži ob ustvarjanju zbirke (oldVersion === 0) ali ob zahtevi za višjo različico. Z oldVersion in newVersion dogodka določi, katere migracije so potrebne. Shemo spreminjaj prek request.result v aktivni transakciji versionchange, dostopni v request.transaction. Ne računaj, da bo transakcija ostala aktivna med čakanjem na nepovezano opravilo, kot je fetch().
blocked pomeni, da zahteva za nadgradnjo čaka, da se zapre druga povezava z isto zbirko. Če povezava že čaka na zaprtje, ji IndexedDB ne pošlje dogodka versionchange, vendar lahko ta povezava še vedno zadrži nadgradnjo, dokler se njene transakcije ne končajo. V aplikaciji obravnavaj versionchange na obstoječi povezavi IDBDatabase in na njej pokliči close(). Z dogodkom blocked uporabniku pojasni razlog za čakanje. Zahteve ni treba ponoviti.
success pomeni, da request.result vsebuje odprto povezavo IDBDatabase. Če je bila potrebna nadgradnja, je njena transakcija že potrjena. Odpiranje trenutne različice ne sproži upgradeneeded. Uspešno odpiranje ne zagotavlja uspeha poznejših transakcij.
error pomeni, da je zahteva spodletela. Preberi DOMException iz request.error. Zahteva za različico, nižjo od shranjene, povzroči VersionError; prekinitev transakcije nadgradnje razveljavi njene spremembe in prepreči uspešno odpiranje. Sinhrono napako, na primer TypeError za različico 0, sproži neposredno open(), ne da bi se sprožil dogodek error.
Primeri
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IndexedDB open request events</title>
</head>
<body>
<pre id="output"></pre>
<script>
(async () => {
const { indexedDB, crypto } = window;
const output = document.getElementById("output");
const name = `ck-tis-idb-${crypto.randomUUID()}`;
function log(line) {
output.textContent += (output.textContent ? "\n" : "") + line;
console.log(line);
}
function open(version, releaseBlocker) {
return new Promise((resolve, reject) => {
const request = indexedDB.open(name, version);
request.onupgradeneeded = ({ oldVersion, newVersion }) => {
log(`upgradeneeded: ${oldVersion} -> ${newVersion}`);
const db = request.result;
if (oldVersion < 1) db.createObjectStore("notes");
if (oldVersion < 2 && newVersion >= 2) db.createObjectStore("tags");
};
request.onblocked = () => {
log(`blocked: ${version}`);
releaseBlocker?.();
};
request.onsuccess = () => {
log(`success: ${request.result.version}`);
resolve(request.result);
};
request.onerror = () => reject(request.error);
});
}
let first;
let second;
try {
first = await open(1);
// Intentionally keep version 1 open until the next request is blocked.
second = await open(2, () => first.close());
try {
const unexpected = await open(1);
unexpected.close();
throw new Error("Expected VersionError");
} catch (error) {
if (error.name !== "VersionError") throw error;
log(`error: ${error.name}`);
}
} finally {
first?.close();
second?.close();
const cleanup = indexedDB.deleteDatabase(name);
cleanup.onerror = () => console.error(cleanup.error);
}
})().catch((error) => console.error(error));
</script>
</body>
</html>Rezultat
upgradeneeded: 0 -> 1 success: 1 blocked: 2 upgradeneeded: 1 -> 2 success: 2 error: VersionError
Odpri stran HTML prek HTTPS ali z naslova localhost v brskalniku, v katerem sta na voljo IndexedDB in `crypto.randomUUID()`. Povezava z različico `1` je namenoma odprta do dogodka `blocked`. Ko se zapre, ista zahteva odpre različico `2`. Naslednja zahteva za različico `1` spodleti z `VersionError`.
Povezane lekcije
- JavaScript · Lekcija 20 · Srednja · Različica: 3
- JavaScript · Lekcija 21 · Srednja · Različica: 3
Viri
- IDBOpenDBRequest
- IDBFactory: open() method
- IDBOpenDBRequest: upgradeneeded event
- IDBOpenDBRequest: blocked event
- IDBRequest: success event
- IDBRequest: error event
- IDBRequest: error property
- IDBRequest: transaction property
- IDBVersionChangeEvent
- IDBDatabase: versionchange event
- Using IndexedDB
- Crypto: randomUUID() method