CKTIS / JavaScript
IDBOpenDBRequest — otvorenie a aktualizácia databázy IndexedDB
IDBOpenDBRequest predstavuje asynchrónnu požiadavku na otvorenie alebo odstránenie databázy IndexedDB. Udalosti umožňujú spracovať aktualizáciu schémy, blokovanie inými pripojeniami a dokončenie operácie. Nie je to pripojenie k databáze ani objekt Promise.
Verzia: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Syntax
const request = indexedDB.open(name, version);
request.onupgradeneeded = (event) => { /* migrate schema */ };
request.addEventListener("blocked", handler);
request.addEventListener("success", handler);
request.addEventListener("error", handler);
// request.transaction: upgrade IDBTransaction or nullVolania indexedDB.open(name, version) a indexedDB.deleteDatabase(name) okamžite vracajú objekt IDBOpenDBRequest. Toto rozhranie dedí z IDBRequest, ktoré dedí z EventTarget. Výsledok získaj prostredníctvom udalostí, nie pomocou await request. Ide o webové API prehliadača z rodiny IndexedDB, nie o súčasť ECMAScriptu. Podľa MDN je rozhranie široko dostupné od júla 2015. MDN samostatne uvádza, že rozhranie je dostupné vo Web Workers. Z uvedeného dátumu nevyplýva, odkedy je podpora vo Web Workers medzi prehliadačmi rozšírená. Prítomnosť Node 24 v repozitári nedokazuje podporu tohto API.
IDBOpenDBRequest.upgradeneeded označuje udalosť upgradeneeded, nie metódu. Vyvolá sa pri vytváraní databázy alebo pri jej otvorení s vyššou verziou. IDBOpenDBRequest.onupgradeneeded je vlastnosť, ktorej môžeš priradiť obsluhu tejto udalosti; alternatívou je addEventListener("upgradeneeded", handler). V obsluhe tejto udalosti vytváraj alebo upravuj úložiská objektov a indexy. Zdedená vlastnosť IDBOpenDBRequest.transaction sprístupňuje transakciu aktualizácie v režime versionchange; bez aktualizácie má hodnotu null. Neodkazuje na ľubovoľnú neskoršiu dátovú transakciu.
IDBOpenDBRequest.blocked označuje udalosť blocked: iné otvorené pripojenie bráni aktualizácii alebo odstráneniu databázy. Ide o stav čakania, nie o konečné zlyhanie. Na každom pripojení obslúž udalosť versionchange tak, že pripojenie zatvoríš pomocou db.close(), a informuj používateľa o blokovaní. Samotná obsluha udalosti blocked nezatvorí ostatné pripojenia.
IDBOpenDBRequest.success a IDBOpenDBRequest.error označujú udalosti zdedené z IDBRequest, ktoré možno obslúžiť aj pomocou onsuccess a onerror. Po úspešnom otvorení obsahuje request.result objekt IDBDatabase; po odstránení databázy má hodnotu undefined. Otvorenie je úspešné až po potvrdení prípadnej transakcie aktualizácie; samotná udalosť upgradeneeded ešte neznamená úspech. Pri chybe skontroluj request.error. Nečítaj výsledok hneď po open(); asynchrónne chyby spracúvaj prostredníctvom udalosti error, oddelene od synchrónnych výnimiek, ktoré môže vyvolať samotné volanie.
Príklady
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IDBOpenDBRequest: opening and upgrading a database</title>
</head>
<body>
<h1>Opening and upgrading an IndexedDB database</h1>
<script>
(() => {
const name = 'cktis-open-' + crypto.getRandomValues(new Uint32Array(4)).join('-');
const report = error => console.log(error.name === 'SecurityError'
? 'IndexedDB unavailable: SecurityError' : `IndexedDB error: ${error.name}`);
let factory, opening;
try {
factory = window.indexedDB;
if (!factory) {
console.log('IndexedDB unavailable: API missing');
return;
}
opening = factory.open(name, 1);
} catch (error) {
report(error);
return;
}
let created = false;
opening.onerror = () => report(opening.error);
opening.onupgradeneeded = () => {
created = true;
opening.result.createObjectStore('notes', { keyPath: 'id' });
};
opening.onsuccess = () => {
const first = opening.result;
if (!created) {
first.close();
console.log('Fixture name already in use');
return;
}
// Hold the old connection open until the new request reports that it is blocked.
const upgrade = factory.open(name, 2);
upgrade.onblocked = event => {
console.log(`blocked: ${event.oldVersion} -> ${event.newVersion}`);
first.close();
};
upgrade.onupgradeneeded = () => {
upgrade.result.createObjectStore('labels');
console.log(`upgrade: ${upgrade.transaction.mode}`);
};
upgrade.onerror = () => {
first.close();
report(upgrade.error);
factory.deleteDatabase(name);
};
upgrade.onsuccess = () => {
const db = upgrade.result;
console.log(`open: ${db.version}, labels: ${db.objectStoreNames.contains('labels')}`);
db.close();
const deletion = factory.deleteDatabase(name);
deletion.onerror = () => report(deletion.error);
deletion.onsuccess = event => console.log(`deleted version: ${event.oldVersion}`);
};
};
})();
</script>
</body>
</html>Výsledok
Observed in the isolated run (IndexedDB access denied): IndexedDB unavailable: SecurityError Expected on a successful run with IndexedDB access: blocked: 1 -> 2 upgrade: versionchange open: 2, labels: true deleted version: 2
Zobrazený kód a deklarovaný výsledok boli overené v izolovanom prostredí metódou uvedenou v doklade o overení tejto konkrétnej verzie.