IDBObjectStore: getAllRecords() method - Web APIs

IDBObjectStore: getAllRecords() method - Web APIs | MDN

Syntax

getAllRecords()
getAllRecords(options)

Parameters

An options object whose properties can include:

query Optional

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

count Optional

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 0 or greater than 2^32 - 1, a TypeError exception will be thrown.

direction Optional

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 in IDBObjectStores.
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 in IDBObjectStores.

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 key property.
value: A value representing the record's value.

Exceptions

This method may raise a DOMException of the following types:

InvalidStateError DOMException: Thrown if the IDBObjectStore has been deleted or removed.
TransactionInactiveError DOMException: Thrown if this IDBObjectStore's transaction is inactive.
TypeError DOMException: Thrown if the count parameter is not between 0 and 2^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

Help improve MDN

Learn how to contribute

This page was last modified on Oct 27, 2025 by MDN contributors.