The getAllKeys() method of the IDBObjectStore interface returns an IDBRequest object retrieves record keys for 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.
Note: This method produces the same result for: a) a record that doesn't exist in the database and b) a record that has an undefined value. To tell these situations apart, call the
openCursor() method with the same key. That method provides a cursor if the record exists, and no cursor if it does not.Syntax
var request = objectStore.getAllKeys([query, count]);
Returns
An IDBRequest object on which subsequent events related to this operation are fired.
Parameters
- query Optional
- A value that is or resolves to an
IDBKeyRange. - count Optional
- Specifies the number of values to return if more than one is found.
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. |
Specifications
| Specification | Status | Comment |
|---|---|---|
| Indexed Database API (Second Edition) The definition of 'getAll()' in that specification. |
Editor's Draft |
Browser compatibility
| Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
|---|---|---|---|---|---|
| Basic support | 48.0 | 27 (27) | ? | ? | ? |
| Feature | Android | Android Webview | Firefox Mobile (Gecko) | Firefox OS | IE Phone | Opera Mobile | Safari Mobile | Chrome for Android |
|---|---|---|---|---|---|---|---|---|
| Basic support | No support | 48.0 | 27.0 (27) | (Yes) | ? | ? | ? | 48.0 |
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.)