IDBIndex.getAll()

There is a performance cost associated with looking at the value property of a cursor, because the object is created lazily. To use a feature like getAll(), Gecko would have to create all the objects at once. If you were just interested in looking at each of the keys, for instance, it would be much more efficient to use a cursor. If you were trying to get an array of all the objects in an object store, though, you could use getAll().

Syntax

var getAllKeysRequest = IDBIndex.getAll(query, count);

Returns

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

Parameters

query Optional

A key or an IDBKeyRange identifying the records to retrieve. If this value is null or missing, the browser will use an unbound key range.

count Optional

The number records to return. If this value exceeds the number of records in the query, the browser will only retrieve the first item. 

Exceptions

This method may raise a DOMException of the following types:

Example

var myIndex = objectStore.index('index');
var getAllKeyRequest = myIndex.getAllKeys();
getAllKeysRequest.onsuccess = function() {
  console.log(getAllKeysRequest.result);
}

Specification

Browser compatibility

 [1] Behind dom.indexedDB.experimental  pref.

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.)