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.
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.
Note: This feature is available in Web Workers
IDBVersionChangeEvent()
Creates and returns a new IDBVersionChangeEvent
object which is used to represent when a version of the database has changed.
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.
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).
js
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.innerHTML += "<li>Error loading database.</li>"; }; DBOpenRequest.onsuccess = (event) => { note.innerHTML += "<li>Database initialized.</li>"; // 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; };
Specification |
---|
Indexed Database API 3.0 # events |
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
IDBVersionChangeEvent |
41 | 79 | 25 | No | 28 | 10 | 41 | 41 | 25 | 28 | 10 | 4.0 |
IDBVersionChangeEvent |
2412 | 12 | 1610–16 | 10 | 1515 | 8 | ≤374.4 | 2518 | 22 | 1414 | 8 | 1.51.0 |
newVersion |
23 | 12 | 10 | 10 | 15 | 8 | 4.4 | 25 | 22 | 14 | 8 | 1.5 |
oldVersion |
23 | 12 | 10 | 10 | 15 | 8 | 4.4 | 25 | 22 | 14 | 8 | 1.5 |
worker_support |
23 | 12 | 37 | 10 | 15 | 10 | 4.4 | 25 | 37 | 14 | 10 | 1.5 |
IDBDatabase
IDBTransaction
IDBKeyRange
IDBObjectStore
IDBCursor
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/IDBVersionChangeEvent