W3cubDocs

/DOM

IDBIndex.count

The count() method of the IDBIndex interface returns an IDBRequest object, and in a separate thread, returns the number of records within a key range.

Note: This feature is available in Web Workers.

Syntax

var myIndex = objectStore.index('index');
var request = myIndex.count();

Returns

A IDBRequest object on which subsequent events related to this operation are fired.

Exceptions

This method may raise a DOMException of one of the following types:

Exception Description
TransactionInactiveError This IDBIndex's transaction is inactive.
DataError

The key or key range provided contains an invalid key.

InvalidStateError The IDBIndex has been deleted or removed.

Example

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.

myIndex.count() is then used to count the number of records in the index, and the result of that request is logged to the console when its success callback returns.

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'); 
  var countRequest = myIndex.count();
  countRequest.onsuccess = function() {
    console.log(countRequest.result);
  }

  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.');    
    }
  };
};

Parameters

key
The key or key range that identifies the record to be counted.

Specification

Specification Status Comment
Indexed Database API
The definition of 'count()' in that specification.
Recommendation

Browser compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 23webkit
24 (unprefixed)
(Yes) 10 moz
16.0 (16.0)
10, partial 15 7.1
Available in workers (Yes) (Yes) 37.0 (37.0) ? (Yes) ?
Feature Android Android Webview Edge Firefox Mobile (Gecko) Firefox OS IE Phone Opera Mobile Safari Mobile Chrome for Android
Basic support 4.4 (Yes) (Yes) 22.0 (22.0) 1.0.1 10 22 8 (Yes)
Available in workers (Yes) (Yes) (Yes) 37.0 (37.0) (Yes) ? (Yes) ? (Yes)

See also

© 2005–2017 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/count