IndexedDB
The getKey() method of the
IDBObjectStore interface returns an IDBRequest object,
and, in a separate thread, returns the key selected by the specified query. This is
for retrieving specific records from an object store.
If a key is successfully found, then a structured clone of it is created and set as the result of the request object.
Syntax
getKey(key)
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 IDBRequest.result property is the key for the first record matching the given key or key range.
Exceptions
This method may raise a DOMException of one of the following types:
InvalidStateErrorDOMException- : Thrown if the IDBObjectStore has been deleted or removed.
TransactionInactiveErrorDOMException- : Thrown if this IDBObjectStore's transaction is inactive.
DataErrorDOMException- : Thrown if the key or key range provided contains an invalid key.
Example
let openRequest = indexedDB.open("telemetry");
openRequest.onsuccess = (event) => {
let db = event.target.result;
let store = db.transaction("net-logs").objectStore("net-logs");
let today = new Date();
let yesterday = new Date(today);
yesterday.setDate(today.getDate() - 1);
let request = store.getKey(IDBKeyRange(yesterday, today));
request.onsuccess = (event) => {
let when = event.target.result;
alert(`The 1st activity in last 24 hours was occurred at ${when}`);
};
};
Specifications
Browser compatibility
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 the example live).
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
