IDBDatabase: deleteObjectStore() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.

Note: This feature is available in Web Workers.

The deleteObjectStore() method of the IDBDatabase interface destroys the object store with the given name in the connected database, along with any indexes that reference it.

As with IDBDatabase.createObjectStore, this method can be called only within a versionchange transaction.

Syntax

js
deleteObjectStore(name)

Parameters

name

The name of the object store you want to delete. Names are case sensitive.

Return value

None (undefined).

Exceptions

InvalidStateError DOMException

Thrown if the method was not called from a versionchange transaction callback.

TransactionInactiveError DOMException

Thrown if a request is made on a source database that doesn't exist (E.g. has been deleted or removed.)

NotFoundError DOMException

Thrown when trying to delete an object store that does not exist.

Examples

js
const dbName = "sampleDB";
const dbVersion = 2;
const request = indexedDB.open(dbName, dbVersion);

request.onupgradeneeded = (event) => {
  const db = request.result;
  if (event.oldVersion < 1) {
    db.createObjectStore("store1");
  }

  if (event.oldVersion < 2) {
    db.deleteObjectStore("store1");
    db.createObjectStore("store2");
  }

  // etc. for version < 3, 4…
};

Specifications

Specification
Indexed Database API 3.0
# ref-for-dom-idbdatabase-deleteobjectstore①

Browser compatibility

BCD tables only load in the browser

See also