IDBObjectStore.getKey()

In This Article

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

Feature	Chrome	Firefox (Gecko)	Internet Explorer	Opera	Safari (WebKit)
Basic support	58	51.0 (51.0)	?	45	?
Available in workers	58	?	?	45	?

Feature	Android Webview	Chrome for Android	Firefox Mobile (Gecko)	IE Phone	Opera Mobile	Safari Mobile
Basic support	58	58	51.0 (51.0)	?	45	?
Available in workers	58	58	(Yes)	?	45	?

Document Tags and Contributors

Tags:

Contributors to this page: jpmedley, teoli

Last updated by: jpmedley, May 5, 2017, 8:40:45 AM