IDBObjectStore.getKey()

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.

Note: This feature is available in Web Workers

Syntax

var request = objectStore.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.

Exceptions

This method may raise a DOMException of one of the following types:

InvalidStateError DOMException: Thrown if the IDBObjectStore has been deleted or removed.
TransactionInactiveError DOMException: Thrown if this IDBObjectStore's transaction is inactive.
DataError DOMException: 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("netlogs").objectStore("netlogs");

  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

Specification
Indexed Database API 3.0 # ref-for-dom-idbobjectstore-getkey①

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
`getKey`	48	79	51	No	45	10.1	48	48	58	43	10.3	5.0

Name	Web APIs
Version
Badge
Last Updated	2022-04-27T09:33:08Z