IDBIndex.getAllKeys()

Syntax

var allKeysRequest = IDBIndex.getAllKeys();
var allKeysRequest = IDBIndex.getAllKeys(query);
var allKeysRequest = IDBIndex.getAllKeys(query, count);

Parameters

query Optional

A key or an IDBKeyRange identifying the keys 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. If it is lower than 0 or greater than 232-1 a TypeError exception will be thrown.

Return value

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

Exceptions

This method may raise a DOMException of the following types:

A TypeError exception is thrown if the count parameter is not between 0 and 232-1 included.

Example

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

Specification

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