The getAll()
method of the IDBObjectStore
interface returns an IDBRequest
object containing 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 either call
- the
openCursor()
method with the same key. That method provides a cursor if the record exists, and no cursor if it does not. - the
count()
method with the same key, which will return 1 if the row exists and 0 if it doesn't.
Syntax
var request = objectStore.getAll(); var request = objectStore.getAll(query); var request = objectStore.getAll(query, count);
Parameters
- query Optional
- A key or
IDBKeyRange
to be queried. If nothing is passed, this will default to a key range that selects all the records in this object store. - count Optional
- Specifies the number of values to return if more than one is found. If it is lower than
0
or greater than232-1
aTypeError
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. |
A TypeError
exception is thrown if the count
parameter is not between 0
and 232-1
included.
Specifications
Specification | Status | Comment |
---|---|---|
Indexed Database API Draft The definition of 'getAll()' in that specification. |
Recommendation | Initial definition |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
getAll | Chrome Full support 48 | Edge Full support ≤79 | Firefox Full support 44 | IE ? | 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
- Compatibility unknown
- Compatibility unknown
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.)