IDBObjectStore: clear() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨July 2015⁩.

Note: This feature is available inWeb Workers.

Theclear() method of theIDBObjectStoreinterface creates and immediately returns anIDBRequest object, andclears this object store in a separate thread. This is for deleting all the currentdata out of an object store.

Clearing an object store consists of removing all records from the object store andremoving all records in indexes that reference the object store. To remove only some ofthe records in a store, useIDBObjectStore.delete passing a keyorIDBKeyRange.

Syntax

clear()

Parameters

None.

Return value

AnIDBRequest object on which subsequent events related to this operation are fired.

If the operation is successful, the value of the request'sresult property isundefined.

Exceptions

InvalidStateErrorDOMException: Thrown if the object store has been deleted.
ReadOnlyErrorDOMException: Thrown if the transaction associated with this operation is in read-onlymode.
TransactionInactiveErrorDOMException: Thrown if thisIDBObjectStore's transaction is inactive.

Examples

In the following code snippet, we open a read/write transaction on our database andclear all the current data out of the object store usingclear(). For afull working example, see ourTo-do Notifications app(view example live).

// Let us open our databaseconst DBOpenRequest = window.indexedDB.open("toDoList", 4);DBOpenRequest.onsuccess = (event) => {  note.appendChild(document.createElement("li")).textContent =    "Database initialized.";  // store the result of opening the database in the db variable.  // This is used a lot below  db = DBOpenRequest.result;  // Clear all the data from the object store  clearData();};function clearData() {  // open a read/write db transaction, ready for clearing the data  const transaction = db.transaction(["toDoList"], "readwrite");  // report on the success of the transaction completing, when everything is done  transaction.oncomplete = (event) => {    note.appendChild(document.createElement("li")).textContent =      "Transaction completed.";  };  transaction.onerror = (event) => {    note.appendChild(document.createElement("li")).textContent =      `Transaction not opened due to error: ${transaction.error}`;  };  // create an object store on the transaction  const objectStore = transaction.objectStore("toDoList");  // Make a request to clear all the data out of the object store  const objectStoreRequest = objectStore.clear();  objectStoreRequest.onsuccess = (event) => {    // report the success of our request    note.appendChild(document.createElement("li")).textContent =      "Request successful.";  };}