IDBIndex:keyPath 属性

注意:此功能在Web Workers中可用。

keyPathIDBIndex 接口的属性,它返回当前索引的键路径。如果为 null,则此索引不会自动填充。

任何可用作键路径的数据类型。

示例

在下面的示例中,我们打开一个事务和一个对象存储,然后从一个简单的联系人数据库中获取索引 lName。然后,我们使用 IDBIndex.openCursor 在索引上打开一个基本游标——这与使用 IDBObjectStore.openCursor 直接在 ObjectStore 上打开游标相同,只是返回的记录是根据索引排序的,而不是根据主键排序的。

当前索引的键路径将记录到控制台:它应返回为 lName

最后,我们遍历每个记录,并将数据插入 HTML 表格中。有关完整的示例,请参阅我们的 IndexedDB-examples 演示仓库 (查看示例)。

js
function displayDataByIndex() {
  tableEntry.textContent = "";
  const transaction = db.transaction(["contactsList"], "readonly");
  const objectStore = transaction.objectStore("contactsList");

  const myIndex = objectStore.index("lName");
  console.log(myIndex.keyPath);

  myIndex.openCursor().onsuccess = (event) => {
    const cursor = event.target.result;
    if (cursor) {
      const tableRow = document.createElement("tr");
      for (const cell of [
        cursor.value.id,
        cursor.value.lName,
        cursor.value.fName,
        cursor.value.jTitle,
        cursor.value.company,
        cursor.value.eMail,
        cursor.value.phone,
        cursor.value.age,
      ]) {
        const tableCell = document.createElement("td");
        tableCell.textContent = cell;
        tableRow.appendChild(tableCell);
      }
      tableEntry.appendChild(tableRow);

      cursor.continue();
    } else {
      console.log("Entries all displayed.");
    }
  };
}

规范

规范
Indexed Database API 3.0
# dom-idbindex-keypath

浏览器兼容性

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

另请参阅