IDBObjectStore: get() method
The get()
method of the IDBObjectStore
interface returns an IDBRequest
object, and, in a separate thread, returns the object selected by the specified key. This is for retrieving specific records from an object store.
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
Parameters
-
key
-
The key or key range that identifies the record to be retrieved.
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 the value of the first record matching the given key or key range.
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.
InvalidStateError
DOMException
-
Thrown if the IDBObjectStore
has been deleted or removed.
Examples
In the following code snippet, we open a read/write transaction on our database and get one specific record from object store using get()
— a sample record with the key "Walk dog". Once this data object is retrieved, you could then update it using normal JavaScript, then put it back into the database using a IDBObjectStore.put
operation. For a full working example, see our To-do Notifications app (view example live).
const DBOpenRequest = window.indexedDB.open("toDoList", 4);
DBOpenRequest.onsuccess = (event) => {
note.innerHTML += "<li>Database initialized.</li>";
db = DBOpenRequest.result;
getData();
};
function getData() {
const transaction = db.transaction(["toDoList"], "readwrite");
transaction.oncomplete = (event) => {
note.innerHTML += "<li>Transaction completed.</li>";
};
transaction.onerror = (event) => {
note.innerHTML += `<li>Transaction not opened due to error: ${transaction.error}</li>`;
};
const objectStore = transaction.objectStore("toDoList");
const objectStoreRequest = objectStore.get("Walk dog");
objectStoreRequest.onsuccess = (event) => {
note.innerHTML += "<li>Request successful.</li>";
const myRecord = objectStoreRequest.result;
};
}
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 |
get |
23 |
12 |
10 |
10 |
15 |
8 |
4.4 |
25 |
22 |
14 |
8 |
1.5 |
See also