IDBObjectStore: getAllKeys() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.

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

getAllKeys()
getAllKeys(query)
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 2^32 - 1 a TypeError exception will be thrown.

Return value

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

If the operation is successful, the value of the request's result property is an Array of the keys for all records matching the given query, up to the value of count, if count was supplied.

Exceptions

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

TransactionInactiveError DOMException: Thrown if this IDBObjectStore's transaction is inactive.
DataError DOMException: Thrown if the key or key range provided contains an invalid key or is null.
InvalidStateError DOMException: Thrown if the IDBObjectStore has been deleted or removed.

Specifications

Specification
Indexed Database API 3.0 # ref-for-dom-idbobjectstore-getallkeys①

Browser compatibility

BCD tables only load in the browser