IDBVersionChangeEvent

This article needs a technical review. How you can help.

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

Note: This feature is available in Web Workers.

Note: The specification has changed and some not up-to-date browsers only support the deprecated unique attribute, version, from an early draft version.

Properties

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

Deprecated properties

IDBVersionChangeEvent.version Read only

The new version of the database in a versionchange transaction.

Warning: While this property is still implemented in older browsers, the latest specification replaces it with the oldVersion and newVersion attributes. See the compatibility table to know what browsers support them.

Example

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 upgradedneeded event), the success event will implement the IDBVersionChangeEvent interface. For a full working example, see our To-do Notifications app (view example live.)

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

// In the following line, you should include the prefixes of implementations you want to test.
window.indexedDB = window.indexedDB || window.mozIndexedDB || window.webkitIndexedDB || window.msIndexedDB;
// DON'T use "var indexedDB = ..." if you're not in a function.
// Moreover, you may need references to some window.IDB* objects:
window.IDBTransaction = window.IDBTransaction || window.webkitIDBTransaction || window.msIDBTransaction;
window.IDBKeyRange = window.IDBKeyRange || window.webkitIDBKeyRange || window.msIDBKeyRange;
// (Mozilla has never prefixed these objects, so we don't need window.mozIDB*)

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

// these two event handlers act on the database being opened successfully, or not
DBOpenRequest.onerror = function(event) {
  note.innerHTML += '<li>Error loading database.</li>';
};
 
DBOpenRequest.onsuccess = function(event) {
  note.innerHTML += '<li>Database initialised.</li>';
    
  // store the result of opening the database in the db variable. This is used a lot later on, for opening transactions and suchlike.
  db = DBOpenRequest.result;
};

Specifications

Specification Status Comment
Indexed Database API
The definition of 'IDBVersionChangeEvent' in that specification.
Recommendation  

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
version 12 webkit

From 4.0 (2.0) to

9.0 (9.0) moz

No support No support No support
oldVersion 23webkit
24

10.0 (10.0) moz
16.0 (16.0)

10, partial 15 7.1
newVersion 23webkit
24

10.0 (10.0) moz
16.0 (16.0)

10, partial 15 7.1
Available in workers (Yes) 37.0 (37.0) ? (Yes) ?
Feature Android Firefox Mobile (Gecko) Firefox OS IE Phone Opera Mobile Safari Mobile
Basic support 4.4 22.0 (22.0) 1.0.1 10 22 No support
Available in workers (Yes) 37.0 (37.0) (Yes) ? (Yes) ?

See also

Document Tags and Contributors

 Last updated by: jpmedley,