The onversionchange
event handler of the IDBDatabase
interface handles the versionchange event, fired when a database structure change (IDBOpenDBRequest.onupgradeneeded
event or IDBFactory.deleteDatabase
) was requested elsewhere (most probably in another window/tab on the same computer).
This is different from the versionchange
transaction (but it is related).
Note: This feature is available in Web Workers.
Syntax
IDBDatabase.onversionchange = function(event) { ... }
Example
This example shows an IDBOpenDBRequest.onupgradeneeded
block that creates a new object store; it also includes onerror
and onabort
functions to handle non-success cases, and an onversionchange function to notify when a database structure change has occurred.
request.onupgradeneeded = function(event) { var db = event.target.result; db.onerror = function(event) { note.innerHTML += '<li>Error opening database.</li>'; }; db.onabort = function(event) { note.innerHTML += '<li>Database opening aborted!</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 }); note.innerHTML += '<li>Object store created.</li>'; db.onversionchange = function(event) { note.innerHTML += '<li>a database change has occurred; you should refresh this browser window, or close it down and use the other open version of this application, wherever it exists.</li>'; }; };
Specifications
Specification | Status | Comment |
---|---|---|
Indexed Database API 2.0 The definition of 'onversionchange' in that specification. |
Recommendation | |
Indexed Database API Draft The definition of 'onversionchange' 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.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
onversionchange | Chrome
Full support
24
| Edge Full support 12 | Firefox
Full support
16
| IE Partial support 10 | Opera Full support 15 | Safari Full support 7 | WebView Android Full support Yes | Chrome Android Full support 25 | Firefox Android Full support 22 | Opera Android Full support 14 | Safari iOS Full support 8 | Samsung Internet Android Full support 1.5 |
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.
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
- Reference example: To-do Notifications (view example live.)
versionchange
event