IDBObjectStore: getAllRecords() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The getAllRecords() method of the IDBObjectStore
interface retrieves all records (including primary keys and values) from the object store.
getAllRecords() effectively combines the functionality of getAllKeys() and getAll() by enumerating both primary keys and values at the same time. This combined operation enables certain data retrieval patterns to be significantly faster than alternatives such as iteration with cursors.
Syntax
getAllRecords()
getAllRecords(options)
Parameters
An options object whose properties can include:
queryOptional-
A key or an
IDBKeyRangeidentifying the records to retrieve. If this value isnullor not specified, the browser will use an unbound key range. countOptional-
The number of records to return. If this value exceeds the number of records in the query, the browser will retrieve only the queried records. If the value is less than
0or greater than2^32 - 1, aTypeErrorexception will be thrown. directionOptional-
An enumerated value specifying the direction in which the records are traversed, which in turn defines the order in which they are returned. Possible values are:
next-
The records are traversed from the beginning, in increasing key order. This is the default value.
nextunique-
The records are traversed from the beginning, in increasing key order. This will yield the same records as
next, because duplicate keys are not allowed inIDBObjectStores. prev-
The records are traversed from the end, in decreasing key order.
prevunique-
The records are traversed from the end, in decreasing key order. This will yield the same records as
prev, because duplicate keys are not allowed inIDBObjectStores.
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 objects representing all records that match the given query, up to the number specified by count (if provided).
Each object contains the following properties:
key-
A value representing the record's key.
primaryKey-
The record's key; identical to the
keyproperty. value-
A value representing the record's value.
Exceptions
This method may raise a DOMException of the following types:
InvalidStateErrorDOMException-
Thrown if the
IDBObjectStorehas been deleted or removed. TransactionInactiveErrorDOMException-
Thrown if this
IDBObjectStore's transaction is inactive. TypeErrorDOMException-
Thrown if the
countparameter is not between0and2^32 - 1, inclusive.
Examples
const query = IDBKeyRange.lowerBound("mykey", true);
const objectStore = transaction.objectStore("contactsList");
const myRecords = (objectStore.getAllRecords({
query,
count: "100",
direction: "prev",
}).onsuccess = (event) => {
console.log("Records successfully retrieved");
});
Specifications
| Specification |
|---|
| Indexed Database API 3.0 # dom-idbobjectstore-getallrecords |
Browser compatibility
Loading…
See also
IDBObjectStore.getAll(),IDBObjectStore.getAllKeys()- 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 - Faster IndexedDB reads with getAllRecords() example from Microsoft, 2025