Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / JavaScript

IDBOpenDBRequest — otwieranie i aktualizacja bazy IndexedDB

IDBOpenDBRequest reprezentuje asynchroniczne żądanie otwarcia lub usunięcia bazy IndexedDB. Pozwala obsłużyć aktualizację schematu, blokadę przez inne połączenia oraz zakończenie operacji. Nie jest połączeniem z bazą ani obiektem Promise.

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

Składnia

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 jest zwracany natychmiast przez indexedDB.open(name, version) i indexedDB.deleteDatabase(name). Dziedziczy po IDBRequest, a następnie po EventTarget; wynik otrzymujesz przez zdarzenia, nie przez await request. To przeglądarkowe Web API z rodziny IndexedDB, nie funkcja ECMAScript. Według MDN interfejs jest szeroko dostępny od lipca 2015 r. MDN osobno wskazuje, że interfejs jest dostępny w Web Workers; podana data nie określa, od kiedy obsługa w Web Workers jest powszechna w przeglądarkach. Node 24 w repozytorium nie dowodzi obsługi tego API.

IDBOpenDBRequest.upgradeneeded oznacza zdarzenie upgradeneeded, a nie metodę. Występuje podczas tworzenia bazy lub otwierania jej z wyższą wersją. IDBOpenDBRequest.onupgradeneeded to właściwość przypisująca jego procedurę obsługi; alternatywą jest addEventListener("upgradeneeded", handler). Tutaj twórz lub zmieniaj magazyny i indeksy. Odziedziczona właściwość IDBOpenDBRequest.transaction udostępnia transakcję aktualizacji w trybie versionchange; bez aktualizacji jest null. Nie oznacza dowolnej późniejszej transakcji danych.

IDBOpenDBRequest.blocked oznacza zdarzenie blocked: inne otwarte połączenie uniemożliwia aktualizację lub usunięcie bazy. To oczekiwanie, nie końcowy błąd. Na każdym połączeniu obsługuj versionchange, zamykając je przez db.close(), i informuj użytkownika o blokadzie. Sam handler blocked nie zamyka cudzych połączeń.

IDBOpenDBRequest.success i IDBOpenDBRequest.error oznaczają zdarzenia odziedziczone po IDBRequest, obsługiwane również przez onsuccess i onerror. Po udanym otwarciu request.result zawiera IDBDatabase, a po usunięciu — undefined. Sukces otwarcia następuje dopiero po zatwierdzeniu wymaganej aktualizacji; upgradeneeded nie jest jeszcze sukcesem. Przy błędzie odczytaj request.error. Nie odczytuj wyniku zaraz po open(); błędy asynchroniczne obsługuj zdarzeniem error, niezależnie od wyjątków synchronicznych samego wywołania.

Przykłady

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

Wynik

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

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła