IDBFactory: deleteDatabase() method

{{APIRef("IndexedDB")}} {{AvailableInWorkers}}

The deleteDatabase() method of the {{DOMxRef("IDBFactory")}} interface requests the deletion of a database. The method returns an {{DOMxRef("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.

Syntax

// 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 {{DOMxRef("IDBDatabase.deleteObjectStore()")}}, which does throw an exception if the named object store does not exist.
• options {{optional_inline}} {{Non-standard_Inline}}
  • : 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 in temporary storage (aka shared pool.)

Return value

An {{DOMxRef("IDBOpenDBRequest")}} on which subsequent events related to this request are fired.

If the operation is successful, the value of the request's {{domxref("IDBRequest.result", "result")}} property is null.

Examples

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

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Using IndexedDB
• Starting transactions: {{DOMxRef("IDBDatabase")}}
• Using transactions: {{DOMxRef("IDBTransaction")}}
• Setting a range of keys: {{DOMxRef("IDBKeyRange")}}
• Retrieving and making changes to your data: {{DOMxRef("IDBObjectStore")}}
• Using cursors: {{DOMxRef("IDBCursor")}}
• Reference example: To-do Notifications (View the example live).