Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / JavaScript

IDBOpenDBRequest — odpiranje in posodabljanje podatkovne zbirke IndexedDB

IDBOpenDBRequest predstavlja asinhrono zahtevo za odpiranje ali brisanje podatkovne zbirke IndexedDB. Z dogodki lahko obravnavaš posodobitve sheme, blokiranje zaradi drugih povezav in zaključek operacije. Ne gre ne za povezavo s podatkovno zbirko ne za Promise.

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

Sintaksa

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 takoj vrne iz indexedDB.open(name, version) in indexedDB.deleteDatabase(name). Podeduje od IDBRequest in nato od EventTarget; rezultat pridobi prek dogodkov, ne z await request. To je brskalniški spletni API iz družine IndexedDB, ne funkcija ECMAScripta. Po podatkih MDN je vmesnik široko dostopen od julija 2015. MDN ločeno navaja, da je vmesnik na voljo v Web Workers. Ta datum ne pove, od kdaj brskalniki vmesnik v Web Workers podpirajo v širšem obsegu. Node 24 v repozitoriju ne dokazuje podpore za ta API.

IDBOpenDBRequest.upgradeneeded označuje dogodek upgradeneeded, ne metode. Sproži se pri ustvarjanju podatkovne zbirke ali njenem odpiranju z višjo različico. IDBOpenDBRequest.onupgradeneeded je lastnost za dodelitev njegovega obravnavalnika; alternativa je addEventListener("upgradeneeded", handler). Tu ustvarjaj ali spreminjaj object store in indekse. Podedovana lastnost IDBOpenDBRequest.transaction razkriva transakcijo nadgradnje v načinu versionchange; brez nadgradnje je njena vrednost null. Ne predstavlja poljubne poznejše podatkovne transakcije.

IDBOpenDBRequest.blocked označuje dogodek blocked: druga odprta povezava preprečuje nadgradnjo ali brisanje podatkovne zbirke. To je stanje čakanja, ne dokončna napaka. Na vsaki povezavi obravnavaj versionchange tako, da jo zapreš z db.close(), uporabnika pa obvesti o blokiranju. Sam obravnavalnik blocked ne zapre drugih povezav.

IDBOpenDBRequest.success in IDBOpenDBRequest.error označujeta dogodka, podedovana od IDBRequest, ki ju lahko obravnavaš tudi prek onsuccess in onerror. Po uspešnem odpiranju request.result vsebuje IDBDatabase; po brisanju je njegova vrednost undefined. Odpiranje uspe šele, ko je potrjena morebitna potrebna nadgradnja; upgradeneeded še ne pomeni uspeha. Ob napaki preveri request.error. Rezultata ne beri takoj po open(); asinhrone napake obravnavaj prek error, ločeno od sinhronih izjem, ki jih sproži sam klic.

Primeri

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

Rezultat

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

Prikazana koda in navedeni rezultat sta bila preverjena v izoliranem okolju z metodo, zapisano v dokazilu o preverjanju te natančne različice.

Viri