openCursor() 方法在 IDBIndex interface returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range.

The method sets the position of the cursor to the appropriate record, based on the specified direction.

  • If the key range is not specified or is null, then the range includes all the records.
  • A success event is always fired on the result object.
    • If at least one record matches the key range, then the result property of the event is set to the new IDBCursorWithValue object; the of the cursor object is set to a structured clone of the referenced value.
    • If no records match the key range then then the result property of the event is set to null .
注意: 此特征可用于 Web 工作者 .

句法

var request = myIndex.openCursor();
var request = myIndex.openCursor(range);
var request = myIndex.openCursor(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 basic cursor on the index using openCursor() — this works the same as opening a cursor directly on an ObjectStore 使用 IDBObjectStore.openCursor except that the returned records are sorted based on the index, not the primary key.

Finally, we iterate through each record, and insert the data into an HTML table. For a complete working example, see our IDBIndex-example demo repo ( View the example live )。

function displayDataByIndex() {
  tableEntry.innerHTML = '';
  var transaction = db.transaction(['contactsList'], 'readonly');
  var objectStore = transaction.objectStore('contactsList');
  var myIndex = objectStore.index('lName');
  myIndex.openCursor().onsuccess = function(event) {
    var cursor = event.target.result;
    if(cursor) {
      var tableRow = document.createElement('tr');
      tableRow.innerHTML =   '<td>' + cursor.value.id + '</td>'
                           + '<td>' + cursor.value.lName + '</td>'
                           + '<td>' + cursor.value.fName + '</td>'
                           + '<td>' + cursor.value.jTitle + '</td>'
                           + '<td>' + cursor.value.company + '</td>'
                           + '<td>' + cursor.value.eMail + '</td>'
                           + '<td>' + cursor.value.phone + '</td>'
                           + '<td>' + cursor.value.age + '</td>';
      tableEntry.appendChild(tableRow);
      cursor.continue();
    } else {
      console.log('Entries all displayed.');
    }
  };
};
							

规范

规范 状态 注释
索引数据库 API 2.0
The definition of 'openCursor()' in that specification.
推荐
索引数据库 API 草案
The definition of 'openCursor()' 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
openCursor 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

图例

完整支持

完整支持

部分支持

部分支持

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

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

另请参阅

元数据

  • 最后修改: