IDBIndex.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.

La méthode getAllKeys(), rattachée à l'interface IDBIndex, permet de récupérer les clés de tous les objets contenus dans l'index et de les enregistrer dans la propriété result de l'objet renvoyé par la méthode.

Syntaxe

js
var getAllKeysRequest = IDBIndex.getAllKeys();
var getAllKeysRequest = IDBIndex.getAllKeys(requete);
var getAllKeysRequest = IDBIndex.getAllKeys(requete, quantite);

Paramètres

requete Facultatif

Une clé ou un intervalle de clé (IDBKeyRange) qui identifie les clés qu'on souhaite récupérer. Si cette valeur vaut null ou est absente, le navigateur utilisera un intervalle de clé sans limite.

quantite Facultatif

Le nombre d'enregistrements qu'on souhaite obtenir. Si cette quantité est supérieure au nombre d'enregistrements récupérés par la requête, le navigateur ne récupèrera que le premier élément. Si elle est négative ou supérieure à 2^32-1, une exception TypeError sera levée.

Valeur de retour

Un objet IDBRequest sur lequel seront reçus les différents évènements rattachés à cette opération.

Exceptions

Cette méthode peut déclencher une des exceptions suivantes :

Exception Description
TransactionInactiveError La transaction pour cet index IDBIndex est inactive.
InvalidStateError L'index IDBIndex a été supprimé ou déplacé.
TypeError Le paramètre quantite n'est pas compris entre 0 et 2^32-1

Exemples

js
var myIndex = objectStore.index("index");
var getAllKeyRequest = myIndex.getAllKeys();
getAllKeysRequest.onsuccess = function () {
  console.log(getAllKeysRequest.result);
};

Spécifications

Specification
Indexed Database API 3.0
# ref-for-dom-idbindex-getallkeys①

Compatibilité des navigateurs

BCD tables only load in the browser

Voir aussi