IDBRequest.onsuccess

The onsuccess event handler of the IDBRequest interface handles the success event, fired when the result of a request is successfully returned.

The event handler takes one parameter, a success Event with type="success".

Syntax

request.onsuccess = function(event) { ... };

Example

The following example requests a given record title, onsuccess gets the associated record from the IDBObjectStore (made available as objectStoreTitleRequest.result), updates one property of the record, and then puts the updated record back into the object store. For a full working example, see our To-do Notifications app (view example live.)

var title = "Walk dog";

// Open up a transaction as usual
var objectStore = db.transaction(['toDoList'], "readwrite").objectStore('toDoList');

// Get the to-do list object that has this title as it's title
var objectStoreTitleRequest = objectStore.get(title);

objectStoreTitleRequest.onsuccess = function() {
  // Grab the data object returned as the result
  var data = objectStoreTitleRequest.result;
 
  // Update the notified value in the object to "yes"
  data.notified = "yes";
 
  // Create another request that inserts the item back
  // into the database
  var updateTitleRequest = objectStore.put(data);
 
  // When this new request succeeds, run the displayData()
  // function again to update the display
  updateTitleRequest.onsuccess = function() {
    displayData();
  };
};

Specifications

Browser compatibilityUpdate compatibility data on GitHub

See also

• Using IndexedDB
• Success Event
• 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.)