IDBIndex.name

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 propriété name, rattachée à l'interface IDBIndex, contient une chaîne de caractères qui permet de désigner l'index courant.

Note : Cette fonctionnalité est disponible via les Web Workers.

Syntaxe

js
var indexName = IDBIndex.name;
IDBIndex.name = indexName;

Valeur

Une chaîne de caractères qui fournit le nom à l'index.

Exceptions

Différentes exceptions peuvent être déclenchées lorsqu'on souhaite modifier le nom d'un index.

InvalidStateError

L'index ou le magasin d'objets a été supprimé ou la transaction courante n'est pas une transaction de montée de niveau. Le renommage des index est uniquement possible lors des transactions de montée de niveau (c'est-à-dire quand le mode de la transaction est "versionchange").

TransactionInactiveError

La transaction courante n'est pas active.

ConstraintError

Il existe déjà un index avec ce nom.

Exemples

Dans l'exemple qui suit, on ouvre une transaction sur un magasin d'objets pour lequel on récupère l'index lName. Ensuite, on ouvre un curseur sur cet index avec la méthode IDBIndex.openCursor() (celle-ci fonctionne comme la méthode openCursor() qui s'utilise sur les magasins d'objets mais ici, les enregistrements sont triés selon l'index et pas selon la clé primaire).

Le nom de l'index est affiché dans la console grâce à la propriété (ici, le nom sera "lName").

Enfin, on parcourt chacun des enregistrements et on ajoute les données dans un tableau HTML.

js
function displayDataByIndex() {
  tableEntry.innerHTML = "";
  var transaction = db.transaction(["contactsList"], "readonly");
  var objectStore = transaction.objectStore("contactsList");

  var myIndex = objectStore.index("lName");
  console.log(myIndex.name);

  myIndex.openCursor().onsuccess = function (event) {
    var cursor = event.target.result;
    if (cursor) {
      var tableRow = document.createElement("tr");
      tableRow.innerHTML =
        "<td>" +
        cursor.value.id +
        "</td>" +
        "<td>" +
        cursor.value.lName +
        "</td>" +
        "<td>" +
        cursor.value.fName +
        "</td>" +
        "<td>" +
        cursor.value.jTitle +
        "</td>" +
        "<td>" +
        cursor.value.company +
        "</td>" +
        "<td>" +
        cursor.value.eMail +
        "</td>" +
        "<td>" +
        cursor.value.phone +
        "</td>" +
        "<td>" +
        cursor.value.age +
        "</td>";
      tableEntry.appendChild(tableRow);

      cursor.continue();
    } else {
      console.log("Les éléments sont affichés.");
    }
  };
}

Note : Pour un exemple fonctionnel complet, voir notre application To-do (exemple).

Spécifications

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

Compatibilité des navigateurs

BCD tables only load in the browser

Voir aussi