IDBCursor.advance()

The advance() method of the IDBCursor interface sets the number of times a cursor should move its position forward.

Note: This feature is available in Web Workers.

Syntax

cursor.advance(count);

Parameters

count
The number of times to move the cursor forward.

Return Value

undefined

Exceptions

This method may raise a DOMException of one of the following types:

Exception Description
TransactionInactiveError This IDBCursor's transaction is inactive.
TypeError The value passed into the count parameter was zero or a negative number.
InvalidStateError The cursor is currently being iterated or has iterated past its end.
 

Example

In this simple fragment we create a transaction, retrieve an object store, then use a cursor to iterate through the records in the object store. Here we use cursor.advance(2) to jump 2 places forward each time, meaning that only every other result will be displayed. advance() works in a similar way to IDBCursor.continue, except that it allows you to jump multiple records at a time, not just always go onto the next record.

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 advanceResult() {
  list.innerHTML = '';
  var transaction = db.transaction(['rushAlbumList'], "readonly");
  var objectStore = transaction.objectStore('rushAlbumList');

  objectStore.openCursor().onsuccess = function(event) {
    var cursor = event.target.result;
    if(cursor) {
      var listItem = document.createElement('li');
      listItem.innerHTML = '<strong>' + cursor.value.albumTitle + '</strong>, ' + cursor.value.year;
      list.appendChild(listItem);  
      cursor.advance(2);
    } else {
      console.log('Every other entry displayed.');
    }
  };
};

Specifications

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

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support

24

23 — 24 webkit

12

16

10 — 16 moz

101157
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support Yes Yes Yes22228 Yes

1. partial

See also

Document Tags and Contributors

 Last updated by: fscholz,