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(); var request = ObjectStore.openCursor(query); var request = ObjectStore.openCursor(query, direction);
Parameters
- query 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. Valid values are"next"
,"nextunique"
,"prev"
, and"prevunique"
. The default is"next"
.
Return value
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
}
};
Specification
Specification | Status | Comment |
Indexed Database API 2.0The definition of 'openCursor()' in that specification. | Recommendation | |
Indexed Database API DraftThe definition of 'openCursor()' in that specification. | Recommendation |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
openCursor
|
Chrome Full support 24 Full support 24 No support 23 — 57 Prefixed' Implemented with the vendor prefix: webkit |
Edge
Full support 12 |
Firefox Full support 16 Full support 16 No support 10 — 16 Prefixed' Implemented with the vendor prefix: moz |
IE
Partial support 10 |
Opera
Full support 15 |
Safari
Full support 7 |
WebView Android Full support Yes Full support Yes No support ? — 57 Prefixed' Implemented with the vendor prefix: webkit |
Chrome Android Full support 25 Full support 25 No support 25 — 57 Prefixed' Implemented with the vendor prefix: webkit |
Firefox Android
Full support 22 |
Opera Android
Full support 14 |
Safari iOS
Full support 8 |
Samsung Internet Android Full support 1.5 Full support 1.5 No support 1.5 — 7.0 Prefixed' Implemented with the vendor prefix: webkit |
Legend
- Full support
- Full support
- Partial support
- Partial support
- Requires a vendor prefix or different name for use.'
- Requires a vendor prefix or different name for use.
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 ([[../../../../../../../mdn.github.io/to-do-notifications/index|view example live]].)
IDBObjectStore.openCursor() by Mozilla Contributors is licensed under CC-BY-SA 2.5.