IDBObjectStore.createIndex()

La méthode createIndex() de l'interface IDBObjectStore met en place sur le magasin d'objet relié un nouvel index et en renvoie l'accès.

Syntaxe

objectStore.createIndex(nomIndex, nomCle, parametresIndexOptionnel);

Paramètres

nomIndex

Le nom de l'index que l'on veut ajouter. Il est possible d'ajouter un index avec un nom vide.

nomCle

Le nom de clé qu'utilise l'index. Il est possible d'ajouter un index sans nom de clé.

parametresIndexOptionnel Facultatif

Un objet optionnel pouvant inclure une ou plusieurs des propriétés suivantes:

Propriété	Description
unique	Si true, l'index empêcheras la duplication d'une clé.
multiEntry	Si true, l'index ajoutera une entrée pour chaque élément de tableau quand le nom de clé de clé est résolue. Si false, il ajoutera un seule entrée contenant le tableau.
locale	Actuellement uniquement dans Firefox 43+ , cela vous permet de spécifier des paramètres de localisation pour l'index. Toutes les opérations de tri effectuées sur les données via des intervalle de clé obéirons aux règles locales de tri (voir trie dans localisation courante, en). Vous pouvez spécifier sa valeur de trois façons différentes: string: une chaîne de caractère contenant le code de la localisation , par exemple 'fr' ou 'en-US'. auto: La localisation par défaut est utilisé (peut être régler par l'utilisateur). null or undefined: Les règles de tri par défaut de javaScript seront utilisées.

Renvoie

L'accès au nouvel index.

Exceptions

InvalidStateError

Cette exeption si la transaction dont dépend cet accès au magasin d'objet n'est pas en mode versionchange.

TransactionInactiveError

Cette exeption si la transaction de l'accès au magasin d’objet est inactive.

Dans les versions de Firefox antérieur à 41, une InvalidStateError est levé dans ce cas aussi, ce qui est trompeur. Cela a été corrigé (voir bug 1176165 ).

ConstraintError

Cette exeption si un index avec le même nom (case sensible) existe déjà sur le magasin d'objet.

Exemple

Dans l'exemple suivant on peut voir le gestionnaire d'événement onupgradeneeded être utilisé pour mètre à jour la structure de la base de donnée quand un numéro de version supérieur est chargé.

Des méthode createIndex() sont utilisées pour mètre en place différents index sur le magasin d'objet toDoList.

var db;

// Requête d'ouverture de la base de données "toDoList"
var DBOpenRequest = window.indexedDB.open("toDoList", 4);

// Gère  l'échec de l'ouverture de la base
DBOpenRequest.onerror = function(event) {
  note.innerHTML += '<li>La base de donnée n\'as pas peut être ouverte.</li>';
};

// Gère le succès de l'ouverture de la base
DBOpenRequest.onsuccess = function(event) {
  note.innerHTML += '<li>La base de données est ouverte.</li>';
 
  //La connexion est affcté à la variable db.
  db = request.result;
 
  // Exécute une fonction d'affichage displayData()
  displayData();
};

// Ce gestionnaire d'événement nécessite  un nouveau numéro de version de la basse de données.
// Si la base n'existe pas un nouveau numéro de version est généré par la méthode d'ouverture de connexion window.indexDB.open .

DBOpenRequest.onupgradeneeded = function(event) {
  var db = event.target.result;
 
  db.onerror = function(event) {
    note.innerHTML += '<li>Erreur de chargement de la base de données.</li>';
  };

  // L'Accès au magasin d'objet "toDoList" de la base de donnée 
  var objectStore = db.createObjectStore("toDoList", { keyPath: "taskTitle" });

  // Met en place les index du magasin d'objet
  objectStore.createIndex("heures", "hours", { unique: false });
  objectStore.createIndex("minutes", "minutes", { unique: false });
  objectStore.createIndex("jour", "day", { unique: false });
  objectStore.createIndex("mois", "month", { unique: false });
  objectStore.createIndex("annee", "year", { unique: false });
  objectStore.createIndex("notifiee", "notified", { unique: false });
};

Pour un exemple de travail complet, voir notre To-do Notifications app (view example live).

Spécifications

Compatibilité avec les navigateurs

Voir aussi

• Utiliser IndexedDB
• Débuter une connexion
• Utilisé les transactions
• Définir l'intervalle des clés
• Accès aux magasins d'objets
• Utiliser les curseur
• Exemple de référence: To-do Notifications (view example live.)