IDBIndex:name 属性

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

name 属性是 IDBIndex 接口的一个字符串,用于命名索引。

指定索引名称的字符串。

异常

尝试更改索引名称时可能会发生几种异常。

InvalidStateError DOMException

如果索引或其对象存储已被删除,或者当前事务不是升级事务,则会抛出此异常。您只能在升级事务期间重命名索引;也就是说,当模式为 "versionchange" 时。

TransactionInactiveError DOMException

如果当前事务未处于活动状态,则会抛出此异常。

ConstraintError DOMException

如果索引已使用指定的 name,则会抛出此异常。

示例

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

索引的名称将记录到控制台中:它应该返回为 lName

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

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

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

  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
# ref-for-dom-idbindex-name①

浏览器兼容性

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

另请参阅