IDBDatabase

Méthodes

Cet objet hérite de EventTarget.

IDBDatabase.close()

Ferme de façon asynchrone la connexion à la base de données.

IDBDatabase.createObjectStore()

Ajoute un magasin d'objet ou un index à la base de donnéeset le renvoie.

IDBDatabase.deleteObjectStore()

À partir d'un nom donné, supprime un magasin d'objet et les index associés.

IDBDatabase.transaction()

Renvoie une transaction sous la forme d'un objet IDBTransaction sur lequel on peut appeler la méthode IDBTransaction.objectStore afin d'accéder aux magasins d'objet de la base de données.

Propriétés

IDBDatabase.name Lecture seule

Une chaîne de caractères (DOMString) qui contient le nom de la base de données connectée.

IDBDatabase.version Lecture seule

Un entier de 64 bits qui indique la version de la base de données connectée. Quand une base de données est créée, cette propriété est une chaîne de caractère vide.

IDBDatabase.objectStoreNames Lecture seule

Une liste de noms (sous la forme d'un objet DOMStringList des magasins d'objets correspondants à la base de données connectée.

Gestionnaires d'événements

IDBDatabase.onabort

S'exécute au déclenchement de l'événement abort quand la tentative d'accès à la base de donnée est interrompue.

IDBDatabase.onerror

S'exécute au déclenchement de l'événement error quand la connexion à la base de donnée échoue.

IDBDatabase.onversionchange

S'exécute au déclenchement de l'événement versionchange quand la structure de la base de donnée change (l'événement IDBOpenDBRequest.onupgradeneeded ou IDBFactory.deleteDatabase à été demandé ailleurs (probablement dans une autre fenêtre ou onglet sur le même ordinateur). Cela est différent de la transaction correspondant à un changement de version (cf. IDBVersionChangeEvent) mais les concepts sont liés.

Exemples

Dans le fragment de code suivant, on ouvre une base de données de façon asynchrone avec IDBFactory puis on gère les cas de succès et d'erreur avant de créer un nouveau magasin d'objet au cas où une mise à jour est nécessaire (IDBdatabase). Pour étudier un exemple complet et fonctionnel, voir notre application To-do Notifications (voir l'exemple live).

// On ouvre la base de données
var DBOpenRequest = window.indexedDB.open("toDoList", 4);

// On ajoute les deux gestionnaires d'événements
// qui agissent sur l'objet IDBDatabase object,
// dans le cas où tout se passe bien ou non
DBOpenRequest.onerror = function (event) {
  note.innerHTML += "<li>Erreur lors du chargement de la base de données.</li>";
};

DBOpenRequest.onsuccess = function (event) {
  note.innerHTML += "<li>Base de données initialisée.</li>";

  // On enregistre le résultat de l'ouverture
  // dans la variable db (on l'utilisera plusieurs
  // fois par la suite).
  db = DBOpenRequest.result;

  // On lance la fonction displayData()
  // afin de remplir la liste de tâches
  // avec les données contenues dans la base
  displayData();
};

// Ce gestionnaire permet de parer au cas où une
// nouvelle version de la base de données doit
// être créée.
// Soit la base de données n'existait pas, soit
// il faut utiliser une nouvelle version

DBOpenRequest.onupgradeneeded = function (event) {
  var db = event.target.result;

  db.onerror = function (event) {
    note.innerHTML +=
      "<li>Erreur lors du chargement de la base de données.</li>";
  };

  // On crée un magasin d'objet objectStore pour
  // cette base de données via IDBDatabase.createObjectStore

  var objectStore = db.createObjectStore("toDoList", { keyPath: "taskTitle" });

  // Enfin, on définit les données qui seront contenues
  // dans ce modèle de données

  objectStore.createIndex("hours", "hours", { unique: false });
  objectStore.createIndex("minutes", "minutes", { unique: false });
  objectStore.createIndex("day", "day", { unique: false });
  objectStore.createIndex("month", "month", { unique: false });
  objectStore.createIndex("year", "year", { unique: false });

  objectStore.createIndex("notified", "notified", { unique: false });

  note.innerHTML += "<li>Magasin d'objets créé.</li>";
};

La ligne qui suit permet d'ouvrir une transaction avec cette base de données afin de consulter le magasin d'objets et de manipuler les données qu'il contient..

var objectStore = db.transaction("toDoList").objectStore("toDoList");

Spécifications

Compatibilité des navigateurs

Voir aussi

• Manipuler IndexedDB
• Démarrer des transactions : IDBDatabase
• Manipuler des transactions : IDBTransaction
• Définir un intervalle de clés : IDBKeyRange
• Récupérer des données et les modifier : IDBObjectStore
• Manipuler des curseurs : IDBCursor
• Exemple de référence pour IndexedDB : To-do Notifications