IDBObjectStore: getAll() method
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
getAll()
getAll(query)
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 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 values of 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 key or key range provided contains an invalid key or is null.
InvalidStateError
DOMException
-
Thrown if the IDBObjectStore
has been deleted or removed.
-
TypeError
-
Thrown if the count
parameter is not between 0
and 2^32 - 1
included.
Specifications
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
getAll |
48 |
79 |
44 |
No |
35 |
10.1 |
48 |
48 |
48 |
35 |
10.3 |
5.0 |
See also