Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / JavaScript

IDBOpenDBRequest — apertura e aggiornamento di un database IndexedDB

IDBOpenDBRequest rappresenta una richiesta asincrona per aprire o eliminare un database IndexedDB. I suoi eventi permettono di gestire gli aggiornamenti dello schema, il blocco da parte di altre connessioni e il completamento dell’operazione. Non è una connessione al database né una Promise.

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

Sintassi

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 viene restituito immediatamente da indexedDB.open(name, version) e indexedDB.deleteDatabase(name). Eredita da IDBRequest e poi da EventTarget; ottieni il risultato tramite eventi, non con await request. È una Web API del browser appartenente alla famiglia IndexedDB, non una funzionalità ECMAScript. Secondo MDN, l’interfaccia è ampiamente disponibile da luglio 2015. MDN segnala separatamente che l’interfaccia è disponibile nei Web Workers; quella data non indica da quando il supporto nei Web Workers è diffuso tra i browser. La presenza di Node 24 in un repository non dimostra il supporto per questa API.

IDBOpenDBRequest.upgradeneeded indica l’evento upgradeneeded, non un metodo. Si attiva quando si crea un database o lo si apre con una versione superiore. IDBOpenDBRequest.onupgradeneeded è la proprietà a cui assegnare il gestore; in alternativa, puoi usare addEventListener("upgradeneeded", handler). Qui puoi creare o modificare object store e indici. La proprietà ereditata IDBOpenDBRequest.transaction espone la transazione di aggiornamento in modalità versionchange; se non c’è un aggiornamento, vale null. Non rappresenta una transazione dati successiva qualsiasi.

IDBOpenDBRequest.blocked indica l’evento blocked: un’altra connessione aperta impedisce l’aggiornamento o l’eliminazione del database. È una condizione di attesa, non un errore definitivo. Gestisci versionchange su ogni connessione chiudendola con db.close(), e informa l’utente del blocco. Un gestore blocked da solo non chiude le altre connessioni.

IDBOpenDBRequest.success e IDBOpenDBRequest.error indicano eventi ereditati da IDBRequest, gestibili anche tramite onsuccess e onerror. Dopo l’apertura riuscita, request.result contiene un IDBDatabase; dopo l’eliminazione, vale undefined. L’apertura riesce solo dopo il completamento di eventuali aggiornamenti necessari; upgradeneeded non indica ancora il successo. In caso di errore, controlla request.error. Non leggere il risultato subito dopo open(); gestisci gli errori asincroni con error, separatamente dalle eccezioni sincrone generate dalla chiamata stessa.

Esempi

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

Risultato

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

Il codice mostrato e il risultato dichiarato sono stati verificati in un ambiente isolato con il metodo registrato nella prova di verifica di questa versione esatta.

Fonti