Web/API/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:

Exception	Description
`TransactionInactiveError`	This `IDBObjectStore`'s transaction is inactive.
`DataError`	The key or key range provided contains an invalid key.
`InvalidStateError`	The `IDBObjectStore` has been deleted or removed.

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	Status	Comment
Indexed Database API DraftThe definition of 'getKey()' in that specification.	Recommendation	Initial definition

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`getKey`	Chrome Full support 48	Edge Full support ≤79	Firefox Full support 51	IE No support No	Opera Full support 45	Safari Full support 10.1	WebView Android Full support 48	Chrome Android Full support 48	Firefox Android Full support 58	Opera Android Full support 43	Safari iOS Full support 10.3	Samsung Internet Android Full support 5.0

Legend

Full support: Full support
No support: No support