IDBCursor.delete()

Syntax

cursor.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:

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 (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

Browser compatibility

See also

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