IDBIndex: Methode getAllKeys()
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.
Die getAllKeys()
-Methode der IDBIndex
-Schnittstelle ruft asynchron die Primärschlüssel aller Objekte im Index ab und setzt sie als result
des Anforderungsobjekts.
Syntax
getAllKeys()
getAllKeys(query)
getAllKeys(query, count)
Parameter
query
Optional-
Ein Schlüssel oder ein
IDBKeyRange
, der die abzurufenden Schlüssel identifiziert. Wenn dieser Wert null ist oder fehlt, verwendet der Browser einen ungebundenen Schlüsselbereich. count
Optional-
Die Anzahl der Datensätze, die zurückgegeben werden sollen. Wenn dieser Wert die Anzahl der Datensätze in der Abfrage überschreitet, ruft der Browser nur das erste Element ab. Wenn er kleiner als
0
oder größer als2^32 - 1
ist, wird eineTypeError
-Ausnahme ausgelöst.
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 der gegebenen Abfrage entsprechen, bis zum Wert von count
, falls count
angegeben wurde.
Ausnahmen
Diese Methode kann eine DOMException
der folgenden Typen auslösen:
TransactionInactiveError
DOMException
-
Wird ausgelöst, wenn die Transaktion dieses
IDBIndex
inaktiv ist. InvalidStateError
DOMException
-
Wird ausgelöst, wenn der
IDBIndex
gelöscht oder entfernt wurde.
Eine TypeError
-Ausnahme wird ausgelöst, wenn der count
-Parameter nicht zwischen 0
und 2^32 - 1
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
BCD tables only load in the browser
Siehe auch
- Verwendung von IndexedDB
- Starten von Transaktionen:
IDBDatabase
- Verwendung von Transaktionen:
IDBTransaction
- Festlegung eines Schlüsselbereichs:
IDBKeyRange
- Abrufen und Ändern Ihrer Daten:
IDBObjectStore
- Verwendung von Cursoren:
IDBCursor
- Referenzbeispiel: To-do-Benachrichtigungen (Beispiel live ansehen).