大网数据广告活动
Web 标准与前端开发

IDBObjectStore: openKeyCursor() method

· 52CE 我爱测

The **`openKeyCursor()`** method of the IDBObjectStore interface returns an IDBRequest object whose result will be set to an IDBCursor that can be used to iterate through matching results. Used for iterating through the keys of an object store with a cursor.

IndexedDB

The openKeyCursor() method of the IDBObjectStore interface returns an IDBRequest object whose result will be set to an IDBCursor that can be used to iterate through matching results. Used for iterating through the keys of an object store with a cursor.

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

Syntax

openKeyCursor()
openKeyCursor(query)
openKeyCursor(query, direction)

Parameters

  • query
    • : The key range 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
    • : A string telling the cursor which direction to travel. The default is next. Valid values are:
      • next
        • : The cursor is opened at the start of the store; then, the cursor returns all records, even duplicates, in the increasing order of keys.
      • nextunique
        • : The cursor is opened at the start of the store; then, the cursor returns all records, that are not duplicates, in the increasing order of keys.
      • prev
        • : The cursor is opened at the end of the store; then, the cursor returns all records, even duplicates, in the decreasing order of keys.
      • prevunique
        • : The cursor is opened at the end of the store; then, the cursor returns all records, that are not duplicates, in the decreasing order of keys.

Return value

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

If the operation is successful, the value of the request's IDBRequest.result property is:

  • an IDBCursor object pointing at the first record matching the given query
  • null if no matching records were found.

Exceptions

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

  • InvalidStateError DOMException
    • : Thrown if this IDBObjectStore or IDBIndex has been deleted.
  • TransactionInactiveError DOMException
    • : Thrown if this IDBObjectStore's transaction is inactive.
  • DataError DOMException
    • : Thrown if the specified key or key range is invalid.

Examples

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:

const transaction = db.transaction("name", "readonly");
const objectStore = transaction.objectStore("name");
const request = objectStore.openKeyCursor();
request.onsuccess = (event) => {
  const cursor = event.target.result;
  if (cursor) {
    // cursor.key contains the key of the current record being iterated through
    // note that there is no cursor.value, unlike for openCursor
    // this is where you'd do something with the result
    cursor.continue();
  } else {
    // no more results
  }
};

Specifications

Browser compatibility

See also

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。