IDBObjectStore.getKey

If a key is successfully found, then a structured clone of it is created and set as the result of the request object.

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 (Second Edition) The definition of 'getKey()' in that specification.	Editor's Draft	Initial definition

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 example live.)