IDBObjectStore: index() method

Note: This feature is available in Web Workers.

The index() method of the IDBObjectStore interface opens a named index in the current object store, after which it can be used to, for example, return a series of records sorted by that index using a cursor.





The name of the index to open.

Return value

An IDBIndex object for accessing the index.


InvalidStateError DOMException

Thrown if the source object store has been deleted, or the transaction for the object store has finished.

NotFoundError DOMException

Thrown if there is no index with the given name (case-sensitive) in the database.


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 IDBIndex.openCursor — this works the same as opening a cursor directly on an ObjectStore using 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 in IndexedDB-examples demo repo (View the example live.)

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

  const myIndex = objectStore.index("lName");
  myIndex.openCursor().onsuccess = (event) => {
    const cursor =;
    if (cursor) {
      const tableRow = document.createElement("tr");
      tableRow.innerHTML =
        `<td>${}</td>` +
        `<td>${cursor.value.lName}</td>` +
        `<td>${cursor.value.fName}</td>` +
        `<td>${cursor.value.jTitle}</td>` +
        `<td>${}</td>` +
        `<td>${cursor.value.eMail}</td>` +
        `<td>${}</td>` +

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


Indexed Database API 3.0
# dom-idbobjectstore-index

Browser compatibility

BCD tables only load in the browser

See also