IDBObjectStore.count

Syntax

var request = ObjectStore.count(optionalKeyRange);

Parameters

optionalKeyRange

A key or IDBKeyRange object that specifies a range of records you want to count.

Returns

An 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
InvalidStateError	This IDBObjectStore has been deleted.
TransactionInactiveError	This IDBObjectStore's transaction is inactive.
DataError	The specified key or key range is invalid.

Example

In this simple fragment we create a transaction, retrieve an object store, then count the number of records in the store using count() — when the success handler fires, we log the count value (an integer) to the console.

var transaction = db.transaction(['fThings'], 'readonly');
var objectStore = transaction.objectStore('fThings');
    
var countRequest = objectStore.count();
countRequest.onsuccess = function() {
  console.log(countRequest.result);
}

Specification

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

Browser compatibility

See also

• Using IndexedDB
• Starting transactions: IDBDatabase
• Using transactions: IDBTransaction
• Setting a range of keys: IDBKeyRange
• Retrieving and making changes to your data: IDBObjectStore
• Using cursors: IDBCursor
• Reference example: To-do Notifications (view example live.)