IDBIndex: getAllKeys() Methode
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since Januar 2020.
Die getAllKeys() Methode des IDBIndex-Interfaces ruft asynchron die Primärschlüssel aller Objekte innerhalb des Index ab und setzt sie als result des Anfrageobjekts.
Syntax
getAllKeys()
getAllKeys(query)
getAllKeys(query, count)
getAllKeys(options)
Parameter
Die getAllKeys() Methode kann separate Parameter oder ein einzelnes Optionsobjekt, das die Parameter als Eigenschaften enthält, übernehmen.
Die Parameter können umfassen:
queryOptional-
Ein Schlüssel oder ein
IDBKeyRange, der die abzurufenden Schlüssel identifiziert. Wenn dieser Wertnullist oder nicht angegeben wurde, verwendet der Browser einen unbeschränkten Schlüsselbereich. countOptional-
Die Anzahl der zurückzugebenden Datensätze. Wenn dieser Wert die Anzahl der Datensätze in der Abfrage überschreitet, ruft der Browser nur das erste Element ab. Wenn er kleiner als
0oder größer als2^32 - 1ist, wird eineTypeError-Ausnahme ausgelöst.
Wenn ein Objektparameter angegeben ist, können seine Eigenschaften umfassen:
queryOptional-
Siehe die frühere Definition von
query. countOptional-
Siehe die frühere Definition von
count. directionOptional-
Ein enumerierter Wert, der die Richtung angibt, in der die Objekte durchlaufen werden. Mögliche Werte sind:
next-
Die Objekte werden von Anfang an in aufsteigender Schlüsselfolge durchlaufen. Dies ist der Standardwert.
nextunique-
Die Objekte werden von Anfang an in aufsteigender Schlüsselfolge durchlaufen. Schlüssel, die über mehrere Objekte hinweg dupliziert sind, werden nur einmal ausgegeben.
prev-
Die Objekte werden von Ende an in absteigender Schlüsselfolge durchlaufen.
prevunique-
Die Objekte werden von Ende an in absteigender Schlüsselfolge durchlaufen. Schlüssel, die über mehrere Objekte hinweg dupliziert sind, werden nur einmal ausgegeben.
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 der Anfrage ein Array der Schlüssel für alle Datensätze, die mit der angegebenen Abfrage übereinstimmen, bis zum Wert von count, falls count angegeben wurde.
Ausnahmen
Diese Methode kann eine DOMException der folgenden Typen auslösen:
TransactionInactiveErrorDOMException-
Wird ausgelöst, wenn die Transaktion dieses
IDBIndexinaktiv ist. InvalidStateErrorDOMException-
Wird ausgelöst, wenn der
IDBIndexgelöscht oder entfernt wurde. TypeErrorDOMException-
Wird ausgelöst, wenn der
count-Parameter nicht zwischen0und2^32 - 1(einschließlich) liegt.
Beispiele
const myIndex = objectStore.index("index");
const getAllKeysRequest = myIndex.getAllKeys();
getAllKeysRequest.onsuccess = () => {
console.log(getAllKeysRequest.result);
};
Spezifikationen
| Specification |
|---|
| Indexed Database API 3.0 # ref-for-dom-idbindex-getallkeys① |
Browser-Kompatibilität
Loading…
Siehe auch
- Verwenden von IndexedDB
- Transaktionen starten:
IDBDatabase - Verwenden von Transaktionen:
IDBTransaction - Einrichten eines Schlüsselbereichs:
IDBKeyRange - Abrufen und Ändern Ihrer Daten:
IDBObjectStore - Verwenden von Cursoren:
IDBCursor - Referenzbeispiel: To-do Benachrichtigungen (Beispiel live ansehen).