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".

Note: This feature is available in Web Workers.

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

Specification Status Comment
Indexed Database API
The definition of 'onsuccess' in that specification.
Recommendation  
Indexed Database API 2.0
The definition of 'onsuccess' in that specification.
Editor's Draft  

Browser compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 23webkit
24 (unprefixed)
(Yes) 10 moz
16.0 (16.0)
10, partial 15 7.1
Available in workers (Yes) ? 37.0 (37.0) ? (Yes) ?
Indexed Database 2.0 58 ? ? ? 45 ?
Feature Android Webview Chrome for Android Edge Firefox Mobile (Gecko) Firefox OS IE Phone Opera Mobile Safari Mobile
Basic support (Yes) (Yes) (Yes) 22.0 (22.0) 1.0.1 10 22 8
Available in workers (Yes) (Yes) ? 37.0 (37.0) (Yes) ? (Yes) ?
Indexed Database 2.0 58 58 ? ? ? ? 45 ?

See also

Document Tags and Contributors

 Contributors to this page: jpmedley, libbymc, rolfedh, robincafolla, chrisdavidmills, fscholz
 Last updated by: jpmedley,