Web/API/IDBCursor/delete

The delete() method of the IDBCursor interface returns an IDBRequest object, and, in a separate thread, deletes the record at the cursor's position, without changing the cursor's position. Once the record is deleted, the cursor's value is set to null.

Be aware that you can't call delete() (or IDBCursor.update()) on cursors obtained from IDBIndex.openKeyCursor(). For such needs, you have to use IDBIndex.openCursor() instead.

Note: This feature is available in Web Workers.

Syntax

myIDBCursor.delete();

Returns

An IDBRequest object on which subsequent events related to this operation are fired. The result attribute is set to undefined.

Exceptions

This method may raise a DOMException of one of the following types:

Exception	Description
`TransactionInactiveError`	This IDBCursor's transaction is inactive.
`ReadOnlyError`	The transaction mode is read-only.
`InvalidStateError`	The cursor was created using `IDBindex.openKeyCursor`, is currently being iterated, or has iterated past its end.

Example

In this simple fragment we create a transaction, retrieve an object store, then use a cursor to iterate through all the records in the object store. If the albumTitle of the current cursor is "Grace under pressure", we delete that entire record using var request = cursor.delete();.

The cursor does not require us to select the data based on a key; we can just grab all of it. Also note that in each iteration of the loop, you can grab data from the current record under the cursor object using cursor.value.foo. For a complete working example, see our IDBCursor example ([[../../../../../../../mdn.github.io/IDBcursor-example/index|view example live]].)

function deleteResult() {
  list.innerHTML = '';
  var transaction = db.transaction(['rushAlbumList'], 'readwrite');
  var objectStore = transaction.objectStore('rushAlbumList');

  objectStore.openCursor().onsuccess = function(event) {
    var cursor = event.target.result;
    if(cursor) {
      if(cursor.value.albumTitle === 'Grace under pressure') {
        var request = cursor.delete();
        request.onsuccess = function() {
          console.log('Deleted that mediocre album from 1984. Even Power windows is better.');
        };
      } else {
        var listItem = document.createElement('li');
        listItem.innerHTML = '<strong>' + cursor.value.albumTitle + '</strong>, ' + cursor.value.year;
        list.appendChild(listItem);   
      }
      cursor.continue();        
    } else {
      console.log('Entries displayed.');         
    }
  };
};

Specifications

Specification	Status	Comment
Indexed Database API 2.0The definition of 'delete()' in that specification.	Recommendation
Indexed Database API DraftThe definition of 'delete()' in that specification.	Recommendation

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`delete`	Chrome Full support 24 Full support 24 No support 23 — 24 Prefixed' Prefixed' Implemented with the vendor prefix: webkit	Edge Full support 12	Firefox Full support 16 Full support 16 No support 10 — 16 Prefixed' Prefixed' Implemented with the vendor prefix: moz	IE Partial support 10	Opera Full support 15	Safari Full support 7	WebView Android Full support Yes	Chrome Android Full support Yes	Firefox Android Full support 22	Opera Android Full support 14	Safari iOS Full support 8	Samsung Internet Android Full support Yes

Legend

Full support: Full support
Partial support: Partial support
Requires a vendor prefix or different name for use.': Requires a vendor prefix or different name for use.