IDBObjectStore: getKey() Methode

Hinweis: Dieses Feature ist verfügbar in Web Workers.

Die getKey()-Methode der IDBObjectStore-Schnittstelle gibt ein IDBRequest-Objekt zurück und gibt in einem separaten Thread den durch die angegebene Abfrage ausgewählten Schlüssel zurück. Dies dient zum Abrufen spezifischer Einträge aus einem Objektspeicher.

Wenn ein Schlüssel erfolgreich gefunden wird, wird ein strukturierter Klon davon erstellt und als Ergebnis des Anfrageobjekts festgelegt.

Syntax

js
getKey(key)

Parameter

key

Der Schlüssel oder der Schlüsselbereich, der den abzurufenden Datensatz identifiziert.

Rückgabewert

Ein IDBRequest-Objekt, bei dem nachfolgende Ereignisse im Zusammenhang mit dieser Operation ausgelöst werden.

Wenn die Operation erfolgreich ist, ist der Wert der result-Eigenschaft des Antrags der Schlüssel für den ersten Datensatz, der mit dem angegebenen Schlüssel oder Schlüsselbereich übereinstimmt.

Ausnahmen

Diese Methode kann eine DOMException der folgenden Typen auslösen:

InvalidStateError DOMException

Wird ausgelöst, wenn das IDBObjectStore gelöscht oder entfernt wurde.

TransactionInactiveError DOMException

Wird ausgelöst, wenn die Transaktion dieses IDBObjectStore inaktiv ist.

DataError DOMException

Wird ausgelöst, wenn der angegebene Schlüssel oder Schlüsselbereich einen ungültigen Schlüssel enthält.

Beispiel

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}`);
  };
};

Spezifikationen

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

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch