IDBIndex.getAllKeys()

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

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 à 232-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 232-1

Exemples

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

Spécifications

Spécification État Commentaires
Indexed Database API 2.0
La définition de 'getAll()' dans cette spécification.
Brouillon de l'éditeur Définition initiale.

Compatibilité des navigateurs

Fonctionnalité Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Support simple 48.0 44.0 (44.0) [1] Pas de support 35 Pas de support
Fonctionnalité Android Android Webview Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile Chrome for Android
Support simple Pas de support 48.0 44.0 (44.0) [1] Pas de support 35 Pas de support 48.0

[1] Cette fonctionnalité était disponible depuis Firefox 24 grâce à la préférence dom.indexedDB.experimental, alors désactivée par défaut.

Voir aussi

Étiquettes et contributeurs liés au document

 Dernière mise à jour par : SphinxKnight,