IDBObjectStore: openKeyCursor() 方法

openKeyCursor() 是 IDBObjectStore 接口的方法，它返回一个 IDBRequest 对象，该对象的返回值将设置为 IDBCursor，可用于遍历匹配的结果。用于使用游标遍历对象存储的键。

要确定添加操作是否已成功完成，请监听结果的 success 事件。

语法

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

参数

query 可选

要查询的键范围。如果传递一个有效的键，这将默认为仅包含该键的范围。如果没有传递任何内容，这将默认为选择此对象存储中所有记录的键范围。

direction 可选

告诉游标移动方向的字符串。默认值为 next。有效值为

next

游标在存储的开头打开；然后，游标以键的升序返回所有记录，包括重复项。

nextunique

游标在存储的开头打开；然后，游标以键的升序返回所有非重复记录。

prev

游标在存储的末尾打开；然后，游标以键的降序返回所有记录，包括重复项。

prevunique

游标在存储的末尾打开；然后，游标以键的降序返回所有非重复记录。

返回值

一个 IDBRequest 对象，在此操作相关的后续事件将在该对象上触发。

如果操作成功，请求的 result 属性的值为

  • 一个 IDBCursor 对象，指向匹配给定查询的第一个记录
  • 如果未找到匹配的记录，则为 null。

异常

此方法可能会引发以下类型的 DOMException

InvalidStateError DOMException

如果此 IDBObjectStore 或 IDBIndex 已被删除，则抛出此异常。

TransactionInactiveError DOMException

如果此 IDBObjectStore 的事务处于非活动状态，则抛出此异常。

DataError DOMException

如果指定的键或键范围无效，则抛出此异常。

示例

在此简单片段中，我们创建一个事务，检索一个对象存储，然后使用游标遍历对象存储中的所有记录

js
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
  }
};

规范

规范
Indexed Database API 3.0
# ref-for-dom-idbobjectstore-openkeycursor①

浏览器兼容性

BCD 表仅在启用 JavaScript 的浏览器中加载。

另请参见