W3cubDocs

/DOM

IDBObjectStore.openCursor

The openCursor() method of the IDBObjectStore interface returns an IDBRequest object, and, in a separate thread, returns a new IDBCursorWithValue object. Used for iterating through an object store with a cursor.

To determine if the add operation has completed successfully, listen for the results’s success event.

Note: This feature is available in Web Workers.

Syntax

var request = ObjectStore.openCursor(optionalKeyRange, optionalDirection);

Returns

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

Exceptions

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

Exception Description
InvalidStateError This IDBObjectStore or IDBIndex has been deleted.
TransactionInactiveError This IDBObjectStore's transaction is inactive.
DataError The specified key or key range is invalid.

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:

var transaction = db.transaction("name", "readonly");
var objectStore = transaction.objectStore("name");
var request = objectStore.openCursor();
request.onsuccess = function(event) {
  var cursor = event.target.result;
  if(cursor) {
    // cursor.value contains the current record being iterated through
    // this is where you'd do something with the result
    cursor.continue();
  } else {
    // no more results
  }
};

Parameters

range Optional
A key or IDBKeyRange to be queried. If a single valid key is passed, this will default to a range containing only that key. If nothing is passed, this will default to a key range that selects all the records in this object store.
direction Optional
An IDBCursorDirection telling the cursor what direction to travel. Defaults to "next".

Specification

Specification Status Comment
Indexed Database API
The definition of 'openCursor' in that specification.
Recommendation

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) ?
Feature Android Android Webview Edge Firefox Mobile (Gecko) Firefox OS IE Phone Opera Mobile Safari Mobile Chrome for Android
Basic support 4.4 (Yes) (Yes) 22.0 (22.0) 1.0.1 10 22 8 (Yes)
Available in workers No support (Yes) ? 37.0 (37.0) (Yes) ? (Yes) ? (Yes)

See also

© 2005–2017 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/openCursor