Web/API/IDBOpenDBRequest/onupgradeneeded

The onupgradeneeded property of the IDBOpenDBRequest interface is the event handler for the upgradeneeded event, triggered when a database of a bigger version number than the existing stored database is loaded.

The event passed to the handler is an IDBVersionChangeEvent.

Inside the event handler function you can include code to upgrade the database structure, as shown in the example below.

Note: This feature is available in Web Workers.

Syntax

IDBOpenDBRequest.onupgradeneeded = function(event) { ... };

Example

In the following example you can see the onupgradeneeded handler being used to update the database structure if a database with a higher version number is loaded. For a full working example, see our To-do Notifications app ([[../../../../../../../mdn.github.io/to-do-notifications/index|view example live]].)

var db;

// Request version 3 of the database.
var request = window.indexedDB.open("library", 3);

// This event handles the event whereby a new version of the
// database needs to be created. Either one has not been created
// before, or a new version number has been submitted via the
// window.indexedDB.open line above.
request.onupgradeneeded = function(event) {
  db = request.result;
 
  db.onerror = function(errorEvent) {
    note.innerHTML += '<li>Error loading database.</li>';
  };

  if (event.oldVersion < 1) {
    // Version 1 is the first version of the database.
    var store = db.createObjectStore("books", {keyPath: "isbn"});
    var titleIndex = store.createIndex("by_title", "title", {unique: true});
    var authorIndex = store.createIndex("by_author", "author");
  }
  if (event.oldVersion < 2) {
    // Version 2 introduces a new index of books by year.
    var bookStore = request.transaction.objectStore("books");
    var yearIndex = bookStore.createIndex("by_year", "year");
  }
  if (event.oldVersion < 3) {
    // Version 3 introduces a new object store for magazines with two indexes.
    var magazines = db.createObjectStore("magazines");
    var publisherIndex = magazines.createIndex("by_publisher", "publisher");
    var frequencyIndex = magazines.createIndex("by_frequency", "frequency");
  }
};

request.onerror = function(event) {
  note.innerHTML += '<li>Error loading database.</li>';
};

request.onsuccess = function(event) {
  note.innerHTML += '<li>Database initialised.</li>';
  db = request.result;
  populateAndDisplayData();
};

Specifications

Specification	Status	Comment
Indexed Database API 2.0The definition of 'onupgradeneeded' in that specification.	Recommendation
Indexed Database API DraftThe definition of 'onupgradeneeded' in that specification.	Recommendation

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`onupgradeneeded`	Chrome Full support 24 Full support 24 No support 23 — 57 Prefixed' Prefixed' Implemented with the vendor prefix: webkit	Edge Full support 12	Firefox Full support 16 Full support 16 No support 10 — 16 Prefixed' Prefixed' Implemented with the vendor prefix: moz	IE Partial support 10	Opera Full support 15	Safari Full support 7	WebView Android Full support Yes Full support Yes No support ? — 57 Prefixed' Prefixed' Implemented with the vendor prefix: webkit	Chrome Android Full support 25 Full support 25 No support 25 — 57 Prefixed' Prefixed' Implemented with the vendor prefix: webkit	Firefox Android Full support 22	Opera Android Full support 14	Safari iOS Full support 8	Samsung Internet Android Full support 1.5 Full support 1.5 No support 1.5 — 7.0 Prefixed' Prefixed' Implemented with the vendor prefix: webkit

Legend

Full support: Full support
Partial support: Partial support
Requires a vendor prefix or different name for use.': Requires a vendor prefix or different name for use.