IDBCursor

The IDBCursor interface of the IndexedDB API represents a cursor for traversing or iterating over multiple records in a database.

The cursor has a source that indicates which index or object store it is iterating over. It has a position within the range, and moves in a direction that is increasing or decreasing in the order of record keys. The cursor enables an application to asynchronously process all the records in the cursor's range.

You can have an unlimited number of cursors at the same time. You always get the same IDBCursor object representing a given cursor. Operations are performed on the underlying index or object store.

Methods

IDBCursor.advance()

Sets the number times a cursor should move its position forward.

IDBCursor.continue()

Advances the cursor to the next position along its direction, to the item whose key matches the optional key parameter.

IDBCursor.delete()

Returns an IDBRequest object, and, in a separate thread, deletes the record at the cursor's position, without changing the cursor's position. This can be used to delete specific records.

IDBCursor.update()

Returns an IDBRequest object, and, in a separate thread, updates the value at the current position of the cursor in the object store. This can be used to update specific records.

Properties

IDBCursor.source Read only

Returns the IDBObjectStore or IDBIndex that the cursor is iterating. This function never returns null or throws an exception, even if the cursor is currently being iterated, has iterated past its end, or its transaction is not active.

IDBCursor.direction Read only

Returns the direction of traversal of the cursor. See Constants for possible values.

IDBCursor.key Read only

Returns the key for the record at the cursor's position. If the cursor is outside its range, this is set to undefined. The cursor's key can be any data type.

IDBCursor.primaryKey Read only

Returns the cursor's current effective primary key. If the cursor is currently being iterated or has iterated outside its range, this is set to undefined. The cursor's primary key can be any data type.

Constants

• NEXT : "next" : The cursor shows all records, including duplicates. It starts at the lower bound of the key range and moves upwards (monotonically increasing in the order of keys).
• NEXTUNIQUE : "nextunique" : The cursor shows all records, excluding duplicates. If multiple records exist with the same key, only the first one iterated is retrieved. It starts at the lower bound of the key range and moves upwards.
• PREV : "prev" : The cursor shows all records, including duplicates. It starts at the upper bound of the key range and moves downwards (monotonically decreasing in the order of keys).
• PREVUNIQUE : "prevunique" : The cursor shows all records, excluding duplicates. If multiple records exist with the same key, only the first one iterated is retrieved. It starts at the upper bound of the key range and moves downwards.

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. 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 displayData() {
  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 = cursor.value.albumTitle + ', ' + cursor.value.year;
      list.appendChild(listItem);  

      cursor.continue();
    } else {
      console.log('Entries all displayed.');
    }
  };
}

Specifications

Browser compatibility

	Desktop Browsers					Mobile Browsers					Non-Browser Environments
	Chrome for Desktop	Firefox for Desktop	Internet Explorer for Desktop	Opera for Desktop	Safari for Desktop	Android Browser	Firefox for Android	Internet Explorer Mobile	Opera Mobile	Safari for iOS	Firefox OS
Basic Support	24.0Full support Notes Implementation Notes Full support24.0 Notes Notes Be careful in Chrome as it still implements the old specification along with the new one. Similarly it still has the prefixed webkitIndexedDB property even if the unprefixed indexedDB is present. Full support23.0 Prefixed Prefixed Requires the vendor prefix: webkit	16.0Full support Implementation Notes Full support16.0   Full support10.0 Prefixed Prefixed Requires the vendor prefix: moz	10.0Partial support	15.0Full support	7.1Full support	4.4Full support	22.0Full support	10.0Full support	22.0Full support	8.0Full support	1.0.1Full support
Available in workers	YesFull support	37.0Full support	?	YesFull support	?	YesFull support	37.0Full support	?	YesFull support	?	YesFull support

Legend

Full support 

Full support

Partial support 

Partial support

Prefixed

Requires a vendor prefix or different name for use.

Notes

See implementation notes

See also

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