IDBIndex.getAll()

Cet article nécessite une relecture technique. Voici comment vous pouvez aider.

Cet article nécessite une relecture rédactionnelle. Voici comment vous pouvez aider.

La méthode getAll() de l'interface IDBIndex fait une requête qui renvoie un tableau ordonné suivant les clés, des clones structurés des enregistrements de l'index relié. On peut limité le nombre d'enregistrements en les filtrants 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 fait un par un. Mais si l'on veut un tableau des clones structurés des valeurs il vaut mieux utilisé getAll(), le moteur Gecko feras les clones structurés en une seul fois.

Syntaxe

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

Paramétres

query Facultatif
Une clé ou l'intervalle de clé pour filtrer, seule 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.

Renvoie

Une requête
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é si la transaction est inactive.
DataError
Cette exception est levé si la clé ou l'intervalle de clé est invalide.
InvalidStateError
Cette exception est levé si l'index à été supprimé.
TypeError
Cette exception est levé si le compteur n'est pas un nombre positif.

Exemple

//on récupéré 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 reussi
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 Statut Commentaire
Indexed Database API (Second Edition)
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 basique 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 basique 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 : gadgino
 Dernière mise à jour par : gadgino,