IDBOpenDBRequest

BaselineWidely available

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

Note: This feature is available inWeb Workers.

TheIDBOpenDBRequest interface of the IndexedDB API provides access to the results of requests to open or delete databases (performed usingIDBFactory.open andIDBFactory.deleteDatabase), using specific event handler attributes.

Instance properties

Also inherits properties from its parentsIDBRequest andEventTarget.

Instance methods

No methods, but inherits methods from its parentsIDBRequest andEventTarget.

Events

Events defined on parent interfaces,IDBRequest andEventTarget, can also be dispatched onIDBOpenDBRequest objects.

Listen to these generic and specific events usingaddEventListener() or by assigning an event listener to theoneventname property of this interface.

Events specific to this interface are:

blocked: Fired when an open connection to a database is blocking aversionchange transaction on the same database. Also available via theonblocked property.
upgradeneeded: Fired when an attempt was made to open a database with a version number higher than its current version. Also available via theonupgradeneeded property.

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 ourTo-do Notifications app (view example live.)

let db;// Let us open our databaseconst DBOpenRequest = window.indexedDB.open("toDoList", 4);// these event handlers act on the database being opened.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 below  db = DBOpenRequest.result;  // Run the displayData() function to populate the task  // list with 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 browsersDBOpenRequest.onupgradeneeded = (event) => {  const db = event.target.result;  db.onerror = (event) => {    note.appendChild(document.createElement("li")).textContent =      "Error loading database.";  };  // Create an objectStore for this database  const 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 });};