The deleteDatabase()
method of the IDBFactory
interface requests the deletion of a database. The method returns an IDBOpenDBRequest
object immediately, and performs the deletion operation asynchronously.
If the database is successfully deleted, then a success
event is fired on the request object returned from this method, with its result
set to undefined
. If an error occurs while the database is being deleted, then an error
event is fired on the request object that is returned from this method.
When deleteDatabase()
is called, any other open connections to this particular database will get a versionchange event.
Note: This feature is available in Web Workers.
Syntax
For the current standard:
var request = indexedDB.deleteDatabase(name);
For the experimental version with options
(see below):
var request = indexedDB.deleteDatabase(name, options);
Parameters
- name
- The name of the database you want to delete. Note that attempting to delete a database that doesn't exist does not throw an exception, in contrast to
IDBDatabase.deleteObjectStore()
, which does throw an exception if the named object store does not exist. - optionsNon-standard
- In Gecko, since version 26, you can include a non-standard optional storage parameter that specifies whether you want to delete a
permanent
(the default value) IndexedDB, or an indexedDB intemporary
storage (aka shared pool.)
Return value
A IDBOpenDBRequest
on which subsequent events related to this request are fired.
Example
var DBDeleteRequest = window.indexedDB.deleteDatabase("toDoList");
DBDeleteRequest.onerror = function(event) {
console.log("Error deleting database.");
};
DBDeleteRequest.onsuccess = function(event) {
console.log("Database deleted successfully");
console.log(event.result); // should be undefined
};
Specifications
Specification | Status | Comment |
Indexed Database API DraftThe definition of 'deleteDatabase()' in that specification. | Recommendation | |
Indexed Database API 2.0The definition of 'deleteDatabase()' in that specification. | Recommendation | Initial definition. |
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
deleteDatabase
|
Chrome Full support 24 Full support 24 No support 23 — 24 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 ? — ? Prefixed' Implemented with the vendor prefix: webkit |
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 ([[../../../../../../../mdn.github.io/to-do-notifications/index|view example live]].)
IDBFactory.deleteDatabase() by Mozilla Contributors is licensed under CC-BY-SA 2.5.