在此页

• 句法
• 范例
• 规范
• 浏览器兼容性
• 另请参阅
• 相关话题

openKeyCursor() 方法在 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 事件。

句法

var request = objectStore.openKeyCursor();
var request = objectStore.openKeyCursor(query);
var request = objectStore.openKeyCursor(query, direction);
					

参数

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 可选

IDBCursorDirection telling the cursor what direction to travel. Valid values are "next" , "nextunique" , "prev" ，和 "prevunique" 。默认为 "next" .

返回值

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

异常

此方法可能引发 DOMException of one of the following types:

异常	描述
InvalidStateError	This IDBObjectStore or IDBIndex has been deleted.
TransactionInactiveError	This IDBObjectStore 's transaction is inactive.
DataError	The specified key or key range is invalid.

范例

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.openKeyCursor();
request.onsuccess = function(event) {
  var 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
  }
};
					

规范

规范	状态	注释
索引数据库 API 2.0 The definition of 'openKeyCursor()' in that specification.	推荐
索引数据库 API 草案 The definition of 'openKeyCursor()' in that specification.	推荐

浏览器兼容性

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. 更新 GitHub 上的兼容性数据

	桌面						移动
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
openKeyCursor	Chrome 24 24 23 — 57 Prefixed Prefixed Implemented with the vendor prefix: webkit	Edge 12	Firefox 44 Disabled 44 Disabled Disabled From version 44: this feature is behind the dom.indexedDB.experimental preference. To change preferences in Firefox, visit about:config.	IE 部分支持 10	Opera 15	Safari 7	WebView Android Yes Yes ? — 57 Prefixed Prefixed Implemented with the vendor prefix: webkit	Chrome Android 25 25 25 — 57 Prefixed Prefixed Implemented with the vendor prefix: webkit	Firefox Android 22	Opera Android 14	Safari iOS 8	Samsung Internet Android 1.5 1.5 1.5 — 7.0 Prefixed Prefixed Implemented with the vendor prefix: webkit

图例

完整支持

完整支持

部分支持

部分支持

用户必须明确启用此特征。

用户必须明确启用此特征。

要求使用供应商前缀或不同名称。

要求使用供应商前缀或不同名称。

另请参阅

• 使用 IndexedDB
• 开始事务： IDBDatabase
• 使用事务： IDBTransaction
• 设置一系列键： IDBKeyRange
• 检索并使您的数据改变： IDBObjectStore
• 使用光标： IDBCursor
• 参考范例： 待办通知 ( 实时查看范例 )。

元数据

• 最后修改： Dec 23, 2019

相关话题

1. IndexedDB API
2. IDBObjectStore
3. 特性

   1. autoIncrement
   2. indexNames
   3. keyPath
   4. 名称
   5. transaction
4. 方法

   1. add()
   2. clear()
   3. count()
   4. createIndex()
   5. delete()
   6. deleteIndex()
   7. get()
   8. getAll()
   9. getAllKeys()
   10. getKey()
   11. index()
   12. openCursor()
   13. openKeyCursor()
   14. put()
5. IndexedDB 相关页面

   1. IDBCursor
   2. IDBCursorSync
   3. IDBCursorWithValue
   4. IDBDatabase
   5. IDBDatabaseException
   6. IDBDatabaseSync
   7. IDBEnvironment
   8. IDBEnvironmentSync
   9. IDBFactory
   10. IDBFactorySync
   11. IDBIndex
   12. IDBIndexSync
   13. IDBKeyRange
   14. IDBObjectStoreSync
   15. IDBOpenDBRequest
   16. IDBRequest
   17. IDBTransaction
   18. IDBTransactionSync
   19. IDBVersionChangeEvent
   20. IDBVersionChangeRequest