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.
Properties
Also inherits properties from its parent, Method
.
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
andnewVersion
attributes. See the compatibility table to know what browsers support them.
Methods
No specific method, but inherits properties from its parent, Method
.
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 ([[../../../../../../mdn.github.io/to-do-notifications/index|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 2.0The definition of 'IDBVersionChangeEvent' in that specification. | Recommendation | Initial definition. |
Indexed Database API DraftThe definition of 'IDBVersionChangeEvent' in that specification. | Recommendation |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
IDBVersionChangeEvent
|
Chrome Full support 24 Full support 24 Full support 12 Prefixed' Implemented with the vendor prefix: webkit |
Edge
Full support 12 |
Firefox Full support 16 Full support 16 No support 10 — 16 Prefixed' Implemented with the vendor prefix: moz |
IE
Partial support 10 |
Opera
Full support 15 |
Safari
Full support 7 |
WebView Android
Full support Yes |
Chrome Android
Full support Yes |
Firefox Android
Full support 22 |
Opera Android
Full support Yes |
Safari iOS
Full support Yes |
Samsung Internet Android
Full support Yes |
newVersion
|
Chrome Full support 24 Full support 24 No support 23 — 57 Prefixed' Implemented with the vendor prefix: webkit |
Edge
Full support 12 |
Firefox Full support 16 Full support 16 No support 10 — 16 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' Implemented with the vendor prefix: webkit |
Chrome Android Full support 25 Full support 25 No support 25 — 57 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' Implemented with the vendor prefix: webkit |
oldVersion
|
Chrome Full support 24 Full support 24 No support 23 — 57 Prefixed' Implemented with the vendor prefix: webkit |
Edge
Full support 12 |
Firefox Full support 16 Full support 16 No support 10 — 16 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' Implemented with the vendor prefix: webkit |
Chrome Android Full support 25 Full support 25 No support 25 — 57 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' Implemented with the vendor prefix: webkit |
Chrome
Full support 12 |
Edge
Full support ≤18 |
Firefox Full support 16 Full support 16 Full support 10 Prefixed' Implemented with the vendor prefix: moz |
IE
No support No |
Opera
No support No |
Safari
No support No |
WebView Android
Full support Yes |
Chrome Android
Full support 18 |
Firefox Android
Full support 22 |
Opera Android
Full support 22 |
Safari iOS
No support No |
Samsung Internet Android
Full support 1.0 | |
Available in workers | Chrome
Full support Yes |
Edge
Full support ≤79 |
Firefox
Full support 37 |
IE
? |
Opera
Full support Yes |
Safari
? |
WebView Android
Full support Yes |
Chrome Android
Full support Yes |
Firefox Android
Full support 37 |
Opera Android
Full support Yes |
Safari iOS
? |
Samsung Internet Android
Full support Yes |
Legend
- Full support
- Full support
- Partial support
- Partial support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
- Non-standard. Expect poor cross-browser support.'
- Non-standard. Expect poor cross-browser support.
- Deprecated. Not for use in new websites.'
- Deprecated. Not for use in new websites.
- Requires a vendor prefix or different name for use.'
- Requires a vendor prefix or different name for use.
See also
- Using IndexedDB
- Starting transactions:
IDBDatabase
- Using transactions:
IDBTransaction
- Setting a range of keys:
IDBKeyRange
- Retrieving and making changes to your data:
IDBObjectStore
- Using cursors:
IDBCursor
- IDBDatabase.onversionchange
- Reference example: To-do Notifications ([[../../../../../../mdn.github.io/to-do-notifications/index|view example live]].)
IDBVersionChangeEvent by Mozilla Contributors is licensed under CC-BY-SA 2.5.