IDBVersionChangeEvent

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.

Note: This feature is available in Web Workers.

The IDBVersionChangeEvent interface of the IndexedDB API indicates that the version of the database has changed, as the result of an onupgradeneeded event handler function.

Constructor

IDBVersionChangeEvent(): Creates and returns a new IDBVersionChangeEvent object which is used to represent when a version of the database has changed.

Instance properties

Also inherits properties from its parent, Event interface.

IDBVersionChangeEvent.oldVersion Read only: Returns the old version of the database.
IDBVersionChangeEvent.newVersion Read only: Returns the new version of the database.

Instance methods

No specific method, but inherits methods from its parent, Event interface.

In the following code snippet, we make a request to open a database, and include handlers for the success and error cases. Upon a version change (after an upgradeneeded event), the success event will implement the IDBVersionChangeEvent interface. For a full working example, see our To-do Notifications app (view example live).

const note = document.querySelector("ul");

// Let us open version 4 of our database
const DBOpenRequest = window.indexedDB.open("toDoList", 4);

// these two event handlers act on the database being opened successfully, or not
DBOpenRequest.onerror = (event) => {
  note.appendChild(document.createElement("li")).textContent =
    "Error loading database.";
};

DBOpenRequest.onsuccess = (event) => {
  note.appendChild(document.createElement("li")).textContent =
    "Database initialized.";

  // store the result of opening the database in the db variable. This is used a lot later on, for opening transactions and suchlike.
  const db = DBOpenRequest.result;
};

Specifications

Specification
Indexed Database API 3.0 # events

Browser compatibility

BCD tables only load in the browser