IDBFactory: deleteDatabase() method
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
js
// For the current standard:
deleteDatabase(name)
// For the experimental version with `options` (see below):
deleteDatabase(name)
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. options
Optional Non-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.
If the operation is successful, the value of the request's result
property is null
.
Examples
js
const DBDeleteRequest = window.indexedDB.deleteDatabase("toDoList");
DBDeleteRequest.onerror = (event) => {
console.error("Error deleting database.");
};
DBDeleteRequest.onsuccess = (event) => {
console.log("Database deleted successfully");
console.log(event.result); // should be undefined
};
Specifications
Specification |
---|
Indexed Database API 3.0 # ref-for-dom-idbfactory-deletedatabase① |
Browser compatibility
BCD tables only load in the browser
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 the example live).