Znalostná bázaCentrum skúšok
SKSlovenčina
Vybrať jazyk13

CKTIS / JavaScript

Otváranie IndexedDB: upgradeneeded, blocked, success a error

Rozlíš, kedy požiadavka na otvorenie IndexedDB potrebuje zmenu schémy, čaká na zatvorenie pripojenia, uspela alebo zlyhala.

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

Syntax

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) ihneď vráti IDBOpenDBRequest, nie Promise. Otváranie prebieha asynchrónne. upgradeneeded a blocked patria k IDBOpenDBRequest; success a error sú zdedené z IDBRequest. Bez version sa otvorí existujúca verzia alebo sa vytvorí databáza vo verzii 1. IndexedDB je API webovej platformy, nie súčasť ECMAScriptu; prístup závisí od prostredia a nastavení úložiska.

upgradeneeded nastane pri vytvorení databázy (oldVersion === 0) alebo pri požiadavke na vyššiu verziu. Podľa oldVersion a newVersion z udalosti vyber potrebné migrácie. Schému meň cez request.result v aktívnej transakcii versionchange dostupnej v request.transaction. Nespoliehaj sa na to, že zostane aktívna pri čakaní na nesúvisiacu operáciu, napríklad fetch().

blocked znamená, že požiadavka na zvýšenie verzie čaká na zatvorenie iného pripojenia k tej istej databáze. Ak už pripojenie čaká na zatvorenie, IndexedDB mu udalosť versionchange nepošle, no toto pripojenie môže zvýšenie verzie zdržať, kým sa jeho transakcie neskončia. V aplikácii obslúž versionchange na existujúcom pripojení IDBDatabase a zavolaj na ňom close(). Pomocou blocked vysvetli používateľovi dôvod čakania. Požiadavku netreba opakovať.

success znamená, že request.result obsahuje otvorené pripojenie IDBDatabase. Ak bola potrebná migrácia, jej transakcia už bola potvrdená. Otvorenie aktuálnej verzie nevyvolá upgradeneeded. Úspešné otvorenie nezaručuje úspech neskorších transakcií.

error znamená, že požiadavka zlyhala. Prečítaj DOMException z request.error. Požiadavka na nižšiu verziu, než je uložená, spôsobí VersionError; prerušenie transakcie migrácie vráti jej zmeny späť a otvorenie zlyhá. Synchrónnu chybu, napríklad TypeError pre verziu 0, vyvolá priamo open() bez udalosti error.

Príklady

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

Výsledok

upgradeneeded: 0 -> 1
success: 1
blocked: 2
upgradeneeded: 1 -> 2
success: 2
error: VersionError

Otvor stránku HTML cez HTTPS alebo z localhostu v prehliadači, v ktorom sú dostupné IndexedDB a `crypto.randomUUID()`. Pripojenie k verzii `1` zostáva zámerne otvorené až do `blocked`. Po jeho zatvorení tá istá požiadavka otvorí verziu `2`. Ďalšia požiadavka na verziu `1` zlyhá s `VersionError`.

Súvisiace lekcie

  • JavaScript · Lekcia 20 · Stredne pokročilá · Verzia: 3
  • JavaScript · Lekcia 21 · Stredne pokročilá · Verzia: 3

Zdroje