The upgradeneeded
event is fired when an attempt was made to open a database with a version number higher than its current version.
Bubbles | No |
---|---|
Cancelable | No |
Interface | Event |
Event handler | onupgradeneeded |
Examples
This example opens a database and handles the upgradeneeded
event by making any necessary updates to the object store.
// Open the database const dBOpenRequest = window.indexedDB.open('toDoList', 4); dBOpenRequest.addEventListener('upgradeneeded', event => { const db = event.target.result; console.log(`Upgrading to version ${db.version}`); // 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 }); });
This is the same example, but uses the onupgradeneeded event handler property.
// Open the database const dBOpenRequest = window.indexedDB.open('toDoList', 4); dBOpenRequest.onupgradeneeded = event => { const db = event.target.result; console.log(`Upgrading to version ${db.version}`); // 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 }); };
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
upgradeneeded event | 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
onupgradeneeded
event handler property