mozilla
Your Search Results

    IDBCursor.update()

    The update() method of the IDBCursor interface returns an IDBRequest object, and, in a separate thread, updates the value at the current position of the cursor in the object store. If the cursor points to a record that has just been deleted, a new record is created.

    Syntax

    cursor.update(newValue);

    Returns

    An IDBRequest object on which subsequent events related to this operation are fired.

    Exceptions

    This method may raise a DOMException with a DOMError 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.
    DataError

    The underlying object store uses in-line keys and the property in the value at the object store's key path does not match the key in this cursor's position.

    DataCloneError The data being stored could not be cloned by the internal structured cloning algorithm.
     

    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 "A farewell to kings", we update year the album was released using  var request = cursor.update();.

    Note that you cannot change primary keys using cursor.update(), hence us not changing the album title; this would ruin the integrity of the data. In such a situation, you would have to delete the record altogether and then add a new one using IDBObjectStore.add. Note also that you can't directly put cursor.value into an update call,  hence the below example using an intermediary updateData variable.

    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 updateResult() {
      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 === 'A farewell to kings') {
            var updateData = cursor.value;
              
            updateData.year = 2050;
            var request = cursor.update(updateData);
            request.onsuccess = function() {
              console.log('A better album year?');
            };
          };
    
          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.');         
        }
      };
    };

    Parameters

    value
    The new value to be stored at the current position.

    Specifications

    Specification Status Comment
    Indexed Database API
    The definition of 'update()' in that specification.
    Candidate Recommendation  

    Browser compatibility

    Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
    Basic support 23webkit
    24
    10 moz
    16.0 (16.0)
    10, partial 15 7.1
    Feature Android Firefox Mobile (Gecko) Firefox OS IE Phone Opera Mobile Safari Mobile
    Basic support 4.4 22.0 (22.0) 1.0.1 10 22 Not supported

    See also

    Document Tags and Contributors

    Contributors to this page: teoli, chrisdavidmills
    Last updated by: teoli,