IDBObjectStore: getAll() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{ APIRef("IndexedDB") }}
The **getAll()** method of the {{domxref("IDBObjectStore")}} interface returns an {{domxref("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 {{domxref("IDBObjectStore.openCursor","openCursor()")}} method with the same
key. That method provides a cursor if the record exists, and no cursor if it does not.
- the {{domxref("IDBObjectStore.count","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)
getAll(options)Parameters
The getAll() method can take separate parameters or a single options object containing the parameters as properties.
The parameters can include:
query{{optional_inline}}- : A key or {{domxref("IDBKeyRange")}} to be queried. If this value is not specified, this will
default to a key range that selects all the records in this object store.
count{{optional_inline}}- : 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 {{jsxref("TypeError")}} exception will be thrown.
If an object parameter is specified, its properties can include:
query{{optional_inline}}- : See the earlier [
query](#query) definition. count{{optional_inline}}- : See the earlier [
count](#count) definition. direction{{optional_inline}}- : An enumerated value specifying the direction in which the objects are traversed. Possible values are:
next- : The objects are traversed from the beginning, in increasing key order. This is the default value.
nextunique- : The objects are traversed from the beginning, in increasing key order. This will yield the same objects as
next, because duplicate keys are not allowed inIDBObjectStores. prev- : The objects are traversed from the end, in decreasing key order.
prevunique- : The objects are traversed from the end, in decreasing key order. This will yield the same objects as
prev, because duplicate keys are not allowed inIDBObjectStores.
Return value
An {{domxref("IDBRequest")}} object on which subsequent events related to this operation are fired.
If the operation is successful, the value of the request's {{domxref("IDBRequest.result", "result")}} property is an {{jsxref("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 {{domxref("DOMException")}} of one of the following types:
TransactionInactiveError{{domxref("DOMException")}}- : Thrown if this {{domxref("IDBObjectStore")}}'s transaction is inactive.
DataError{{domxref("DOMException")}}- : Thrown if key or key range provided contains an invalid key or is null.
InvalidStateError{{domxref("DOMException")}}- : Thrown if the {{domxref("IDBObjectStore")}} has been deleted or removed.
- {{jsxref("TypeError")}}
- : Thrown if the [
count](#count) parameter is not between0and2^32 - 1, inclusive.
Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- Using IndexedDB
- Starting transactions: {{domxref("IDBDatabase")}}
- Using transactions: {{domxref("IDBTransaction")}}
- Setting a range of keys: {{domxref("IDBKeyRange")}}
- Retrieving and making changes to your data: {{domxref("IDBObjectStore")}}
- Using cursors: {{domxref("IDBCursor")}}
- Reference example: To-do Notifications (View the example live).