Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

IDBOpenDBRequest — otevření a aktualizace databáze IndexedDB

IDBOpenDBRequest představuje asynchronní požadavek na otevření nebo odstranění databáze IndexedDB. Události umožňují řešit aktualizace schématu, blokování jinými připojeními a dokončení operace. Nejde o připojení k databázi ani o Promise.

Verze: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Syntaxe

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 null

IDBOpenDBRequest se okamžitě vrací z volání indexedDB.open(name, version) a indexedDB.deleteDatabase(name). Dědí z IDBRequest a následně z EventTarget; výsledek získáš pomocí událostí, nikoli přes await request. Jde o webové API prohlížeče z rodiny IndexedDB, nikoli o funkci ECMAScriptu. Podle MDN je rozhraní široce dostupné od července 2015. MDN samostatně uvádí, že rozhraní je dostupné ve Web Workers. Z uvedeného data nevyplývá, od kdy je podpora ve Web Workers mezi prohlížeči rozšířená. Node 24 v repozitáři nedokládá podporu tohoto API.

IDBOpenDBRequest.upgradeneeded označuje událost upgradeneeded, nikoli metodu. Vyvolá se při vytváření databáze nebo při jejím otevření s vyšší verzí. IDBOpenDBRequest.onupgradeneeded je vlastnost pro přiřazení obslužné rutiny; alternativou je addEventListener("upgradeneeded", handler). Zde vytvářej nebo upravuj object store a indexy. Zděděná vlastnost IDBOpenDBRequest.transaction zpřístupňuje aktualizační transakci v režimu versionchange; bez aktualizace má hodnotu null. Nepředstavuje libovolnou pozdější datovou transakci.

IDBOpenDBRequest.blocked označuje událost blocked: jiné otevřené připojení brání aktualizaci nebo odstranění databáze. Jde o čekání, nikoli o konečné selhání. Na každém připojení zpracuj versionchange tak, že je zavřeš pomocí db.close(), a informuj uživatele o blokování. Samotná obsluha blocked jiná připojení nezavře.

IDBOpenDBRequest.success a IDBOpenDBRequest.error označují události zděděné z IDBRequest, které lze obsluhovat také pomocí onsuccess a onerror. Po úspěšném otevření obsahuje request.result objekt IDBDatabase; po odstranění má hodnotu undefined. Otevření uspěje až po potvrzení případné potřebné aktualizace; upgradeneeded ještě neznamená úspěch. Při chybě zkontroluj request.error. Nečti výsledek ihned po open(); asynchronní chyby obsluhuj pomocí error, odděleně od synchronních výjimek vyvolaných samotným voláním.

Pří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ýsledek

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 uvedený výsledek byly ověřeny v izolovaném prostředí metodou zaznamenanou v dokladu o ověření této přesné verze.

Zdroje