web api instance method

IDBDatabase: deleteObjectStore() method

Available in 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 createObjectStore, this method can be called only within a versionchange transaction.

Syntax

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

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

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.