The name property of the IDBIndex interface contains a string which names the index.

Note: This feature is available in Web Workers.


var indexName =; = indexName;


A DOMString specifying a name for the index.


There are a several exceptions which can occur when you attempt to change an index's name.

The index, or its object store, has been deleted; or the current transaction is not an upgrade transaction. You can only rename indexes during upgrade transactions; that is, when the mode is "versionchange".
The current transaction is not active.
An index is already using the specified name.


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 IDBObjectStore using openCursor() except that the returned records are sorted based on the index, not the primary key.

The name of the index is logged to the console: it should be returned as lName.

Finally, we iterate through each record, inserting 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 =;
    if(cursor) {
      var 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>'
                           + '<td>' + cursor.value.age + '</td>';

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


Specification Status Comment
Indexed Database API
The definition of 'name' in that specification.
Indexed Database API 2.0
The definition of 'name' in that specification.

Browser compatibility

We're converting our compatibility data into a machine-readable JSON format. This compatibility table still uses the old format, because we haven't yet converted the data it contains. Find out how you can help!

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 23webkit
(Yes) 10 moz
16.0 (16.0)
10, partial 15 7.1
Available in workers (Yes) (Yes) 37.0 (37.0) ? (Yes) ?
Renaming with name setter (Yes) ? 49 (49) ? ? ?
Indexed Database 2.0 58 ? ? ? 45 ?
Feature Android Webview Chrome for Android Edge Firefox Mobile (Gecko) Firefox OS IE Phone Opera Mobile Safari Mobile
Basic support (Yes) (Yes) (Yes) 22.0 (22.0) 1.0.1 10 22 8
Available in workers (Yes) (Yes) (Yes) 37.0 (37.0) (Yes) ? (Yes) ?
Renaming with name setter (Yes) (Yes) ? 49.0 (49) ? ? ? ?
Indexed Database 2.0 58 58 ? ? ? ? 45 ?

See also

Document Tags and Contributors

 Contributors to this page: jpmedley, arronei, libbymc, Sheppy, chrisdavidmills, fscholz
 Last updated by: jpmedley,