IDBObjectStore: getKey() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.

Note: This feature is available in Web Workers.

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

js
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 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:

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

js
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

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

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
getKey

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support

See also