注意： 此特征可用于 Web 工作者 .

句法

var request = myIndex.openKeyCursor();
var request = myIndex.openKeyCursor(range);
var request = myIndex.openKeyCursor(range, direction);
						

参数

range 可选

A key or IDBKeyRange to use as the cursor's range. If nothing is passed, this will default to a key range that selects all the records in this object store.

direction 可选

The cursor's direction 。见 IDBCursor Constants 对于可能的值。

返回值

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

异常

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

异常	描述
TransactionInactiveError	This IDBIndex 's transaction is inactive.
TypeError	The value for the direction parameter is invalid.
DataError	The key or key range provided contains an invalid key.
InvalidStateError	IDBIndex has been deleted or removed.

范例

In the following example we open a transaction and an object store, then get the index lName from a simple contacts database. We then open a key cursor on the index using openKeyCursor() — this works the same as opening a cursor directly on an ObjectStore 使用 IDBObjectStore.openKeyCursor except that the returned records are sorted based on the index, not the primary key.

Finally, we iterate through each record in the index, and insert the last name and the corresponding primary key of the referenced record into an HTML table.

function displayDataByIndex() {
  tableEntry.innerHTML = '';
  var transaction = db.transaction(['contactsList'], 'readonly');
  var objectStore = transaction.objectStore('contactsList');
  var myIndex = objectStore.index('lName');
  myIndex.openKeyCursor().onsuccess = function(event) {
    var cursor = event.target.result;
    if(cursor) {
      var tableRow = document.createElement('tr');
      tableRow.innerHTML =   '<td>' + cursor.key + '</td>'
                           + '<td>' + cursor.primaryKey + '</td>';
      tableEntry.appendChild(tableRow);
      cursor.continue();
    } else {
      console.log('All last names displayed.');
    }
  };
};
							

规范

规范	状态	注释
索引数据库 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 — 24 Prefixed Prefixed Implemented with the vendor prefix: webkit	Edge 12	Firefox 16 16 10 — 16 Prefixed Prefixed Implemented with the vendor prefix: moz	IE 部分支持 10	Opera 15	Safari 7	WebView Android Yes Yes ? — ? Prefixed Prefixed Implemented with the vendor prefix: webkit	Chrome Android 25	Firefox Android 22	Opera Android 14	Safari iOS 8	Samsung Internet Android 1.5

图例

完整支持

完整支持

部分支持

部分支持

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

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

另请参阅

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

元数据

• 最后修改： May 24, 2020