Web/API/IDBObjectStore/getAllKeys

The getAllKeys() method of the IDBObjectStore interface returns an IDBRequest object retrieves record keys for all objects in the object store matching the specified parameter or all objects in the store if no parameters are given.

If a value is successfully found, then a structured clone of it is created and set as the result of the request object.

This method produces the same result for:

a record that doesn't exist in the database
a record that has an undefined value

To tell these situations apart, you need to call the openCursor() method with the same key. That method provides a cursor if the record exists, and no cursor if it does not.

Syntax

var request = objectStore.getAllKeys();
var request = objectStore.getAllKeys(query);
var request = objectStore.getAllKeys(query, count);

Parameters

query Optional: A value that is or resolves to an IDBKeyRange.
count Optional: Specifies the number of values to return if more than one is found. 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 one of the following types:

Exception	Description
`TransactionInactiveError`	This `IDBObjectStore`'s transaction is inactive.
`DataError`	The key or key range provided contains an invalid key or is null.
`InvalidStateError`	The `IDBObjectStore` has been deleted or removed.

Specifications

Specification	Status	Comment
Indexed Database API DraftThe definition of 'getAllKeys()' in that specification.	Recommendation	Initial definition

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`getAllKeys`	Chrome Full support 48	Edge Full support ≤79	Firefox Full support 44	IE No support No	Opera Full support 35	Safari Full support 10.1	WebView Android Full support 48	Chrome Android Full support 48	Firefox Android Full support 48	Opera Android Full support 35	Safari iOS Full support 10.3	Samsung Internet Android Full support 5.0

Legend

Full support: Full support
No support: No support