This API is available on Firefox OS for internal applications only.

The DataStoreChangeEvent interface of the Data Store API represents the event related to a record changed in the data store, i.e. this is returned once a change is made and the change event is fired (see DataStore.onchange for the handler).

Note: The Data Store API is available in Web Workers, from Firefox 32 onwards (Firefox OS 2.0; see bug 949325.)

Properties Read only
Returns the identifier of the changed record in the data store. Must return null if the operation is cleared.
DataStoreChangeEvent.operation Read only
Returns the type of operation that represents the current change that has been made to the data store.
DataStoreChangeEvent.owner Read only
Returns the manifest URL of the application that made the change to the data store.
DataStoreChangeEvent.revisionId Read only
Returns the id of the current revision of the data store, i.e. the current change that has been made to a data record.


In the following snippet we retrieve all the data stores on the device with the name "contacts", then we use DataStore.sync to create a cursor to use for syncing the app with the current "content" data store (displaying new items, etc.) This cursor is passed to the runNextTask() function that will deal with running through the updates in some way. Next, we include some code inside an onchange function so that when a change is made we return the DataStoreChangeEvent (e in this case), find out what type of operation the change is, and then take action based on this type (either adding or deleting a contact's information.)

navigator.getDataStores('contacts').then(function(stores) {
  var cursor = stores[0].sync();

  stores[0].onchange = function(e) {
    if (e.operation == 'removed') {
      // Delete the contact

    if (e.operation == 'added') {
      stores[0].get( {
        // Add the new contact

Note: To see this code used in the context of a complete app, check out our The Data Store Contacts Viewer example changeevent version on GitHub.

Operation types

The different operation types used in DataStoreChangeEvent are (see also the spec definitions):

Enumeration Description
added The record is added into the data store.
updated The record is updated in the data store.
removed The record is deleted from the data store.
cleared All records are deleted from the data store.

Note: These are currently different to the operation types returned by DataStoreTask. This discrepancy will be fixed soon at an appropriate time.


Specification Status Comment
Data Store API
The definition of 'DataStoreChangeEvent' in that specification.

The discussion concerning this API's creation happened in various Mozilla mailing lists and other places. A summary of the discussion and further pointers can be found on the Mozilla Wiki. For further feedback and questions, send mail to the dev-webapi mailing list.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support No support No support No support No support No support
Feature Android Chrome Firefox Mobile (Gecko) Firefox OS IE Phone Opera Mobile Safari Mobile
Basic support No support No support No support 1.0.1 No support No support No support
Available in web workers No support No support No support 2.0 No support No support No support

See also


© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.

API Data Store Data Store API Database DataStoreChangeEvent Interface Non-standard Reference Référence Storage storage