MDN’s new design is in Beta! A sneak peek: https://blog.mozilla.org/opendesign/mdns-new-design-beta/

IDBIndex.getAll()

La méthode getAll() de l'interface IDBIndex fait une requête (IDBRequest) qui renvoie un tableau ordonné suivant les clés, des clones structurés des enregistrements de l'index relié (IDBIndex). On peut limiter le nombre d'enregistrements en les filtrant suivant leurs clés ou en paramétrant le compteur.

On peut comparer cette méthode avec une recherche par curseur. Effectivement, il est plus intéressant si l'on veut accéder aux enregistrements un par un d'utiliser un curseur, les clones structurés des valeurs seront faits un par un. Mais si l'on veut un tableau des clones structurés des valeurs il vaut mieux utiliser getAll(), le moteur Gecko fera les clones structurés en une seule fois.

Syntaxe

var getAllKeysRequest = IDBIndex.getAll(query, count);

Paramètres

query Facultatif
Une clé ou un intervalle de clé (IDBKeyRange) pour filtrer, seules les valeurs des enregistrements correspondant sont renvoyées. Par défaut toutes les clones structurés des enregistrements de l'index relié sont renvoyés.
count Facultatif
Le nombre d'enregistrement maximum renvoyés. Un nombre décimal sera tronqué. Zéro annule le compteur et toutes les valeurs sont retournées.

Valeur de retour

Un objet IDBRequest
La propriété result de cette requête renvoie le tableau des clones structurés des enregistrements en cas de succès.

Exceptions

TransactionInactiveError
Cette exception est levée si la transaction (IDBTransaction) est inactive.
DataError
Cette exception (DOMException) est levée si la clé ou l'intervalle de clé (IDBKeyRange) est invalide.
InvalidStateError
Cette exception (DOMException) est levée si l'index à été supprimé.
TypeError
Cette exception (DOMException) est levée si le compteur n'est pas un nombre positif.

Exemple

//on récupère l’accès à l'index
var myIndex = objectStore.index('index');
//on fait une requête de recherche sur l'index
var getAllKeyRequest = myIndex.getAllKeys();
//si la requête réussi
getAllKeysRequest.onsuccess = function() {
  //on affiche le résultat sur la console 
  //~= [{key:'a',value:un_clone_structuré},{key:'2',value:un_clone_structuré},...]
  console.log(getAllKeysRequest.result);
}

Spécification

Spécification État Commentaires
Unknown
La définition de 'getAll()' dans cette spécification.
Recommendation Initial definition.

Compatibilité avec les navigateurs

Fonctionnalité Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Support simple 23webkit
24
10 moz
16.0 (16.0)
10, en partie 15 7.1
count() 23 22.0 (22.0) 10, en partie 15 7.1
getAll() 48.0 24.0 (24.0) [1] Pas de support Pas de support Pas de support
getAllKeys() 48.0 24.0 (24.0) [1] Pas de support Pas de support Pas de support
Fonctionnalité Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Phone Opera Mobile Safari Mobile Chrome for Android
Support simple 4.4 (Oui) 22.0 (22.0) 1.0.1 10 22 Pas de support (Oui)
count() 4.4 (Oui) 22.0 (22.0) 1.0.1 10 22 Pas de support (Oui)
getAll() Pas de support 48.0 24.0 (24.0) [1] 1.1 [2] Pas de support Pas de support Pas de support 48.0
getAllKeys() Pas de support 48.0 24.0 (24.0) [1] 1.1 [2] Pas de support Pas de support Pas de support 48.0

 [1] Behind dom.indexedDB.experimental  pref.

Voir aussi

Étiquettes et contributeurs liés au document

 Contributeurs à cette page : AdeLyneBD, gadgino
 Dernière mise à jour par : AdeLyneBD,