W3cubDocs

/DOM

IDBOpenDBRequest

The IDBOpenDBRequest interface of the IndexedDB API provides access to the results of requests to open or delete databases (performed using IDBFactory.open and IDBFactory.deleteDatabase), using specific event handler attributes.

Note: This feature is available in Web Workers.

Properties

Also inherits methods from its parents IDBRequest and EventTarget.

Events

IDBOpenDBRequest.onblocked: The event handler for the blocked event. This event is triggered when the upgradeneeded event should be triggered because of a version change but the database is still in use (i.e. not closed) somewhere, even after the versionchange event was sent.
IDBOpenDBRequest.onupgradeneeded: The event handler for the upgradeneeded event, fired when a database of a bigger version number than the existing stored database is loaded.
Methods No methods, but inherits methods from its parents IDBRequest and EventTarget.

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 (view example live.)

var db;

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

// these event handlers act on the database being opened.
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 below
  db = DBOpenRequest.result;
 
  // Run the displayData() function to populate the task
  // listwith all the to-do list data already in the IDB
  displayData();
};

// 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
// it is only implemented in recent browsers
DBOpenRequest.onupgradeneeded = function(event) {
  var db = this.result;
 
  db.onerror = function(event) {
    note.innerHTML += '<li>Error loading database.</li>';
  };

  // Create an objectStore for this database   
  var objectStore = db.createObjectStore("toDoList", { keyPath: "taskTitle" });

  // define what data items the objectStore will contain
    
  objectStore.createIndex("hours", "hours", { unique: false });
  objectStore.createIndex("minutes", "minutes", { unique: false });
  objectStore.createIndex("day", "day", { unique: false });
  objectStore.createIndex("month", "month", { unique: false });
  objectStore.createIndex("year", "year", { unique: false });
  objectStore.createIndex("notified", "notified", { unique: false });
};

Specifications

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

Browser compatibilityUpdate compatibility data on GitHub

	Desktop
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari
Basic support	24 24 23 — 57 Prefixed Prefixed Requires the vendor prefix: webkit	Yes	16 16 10 — 16 Prefixed Prefixed Requires the vendor prefix: moz	10 10 partial	15	7
Available in workers	Yes	?	37	?	Yes	?
`onblocked`	24 24 23 — 57 Prefixed Prefixed Requires the vendor prefix: webkit	12	16 16 10 — 16 Prefixed Prefixed Requires the vendor prefix: moz	10 10 partial	15	7
`onupgradeneeded`	24 24 23 — 57 Prefixed Prefixed Requires the vendor prefix: webkit	12	16 16 10 — 16 Prefixed Prefixed Requires the vendor prefix: moz	10 10 partial	15	7

	Mobile
	Android webview	Chrome for Android	Edge Mobile	Firefox for Android	Opera for Android	iOS Safari	Samsung Internet
Basic support	Yes Yes ? — 57 Prefixed Prefixed Requires the vendor prefix: webkit	25 25 25 — 57 Prefixed Prefixed Requires the vendor prefix: webkit	Yes	22	22	8	Yes Yes ? — 7.0 Prefixed Prefixed Requires the vendor prefix: webkit
Available in workers	Yes	Yes	Yes	37	Yes	?	Yes
`onblocked`	Yes Yes ? — 57 Prefixed Prefixed Requires the vendor prefix: webkit	25 25 25 — 57 Prefixed Prefixed Requires the vendor prefix: webkit	Yes	22	22	8	Yes Yes ? — 7.0 Prefixed Prefixed Requires the vendor prefix: webkit
`onupgradeneeded`	Yes Yes ? — 57 Prefixed Prefixed Requires the vendor prefix: webkit	25 25 25 — 57 Prefixed Prefixed Requires the vendor prefix: webkit	Yes	22	22	8	Yes Yes ? — 7.0 Prefixed Prefixed Requires the vendor prefix: webkit