IDBFactory.deleteDatabase()
La méthode deleteDatabase()
, rattachée à l'interface IDBFactory
, permet de demander la suppression d'une base de données. La méthode renvoie immédiatement un objet IDBOpenDBRequest
puis effectue l'opération de suppression de façon asynchrone.
Si la base de données est bien supprimée, un évènement success
est déclenché sur l'objet IDBOpenDBRequest
renvoyé et la propriété result
vaut alors undefined
. Si une erreur se produit lors de la suppression, ce sera un évènement error
qui sera déclenché sur l'objet renvoyé par la méthode.
Lorsque la méthode deleteDatabase()
est invoquée, toutes les autres connexions qui sont ouvertes sur cette base de données recevront un évènement versionchange
.
Note : Cette fonctionnalité est disponible via les Web Workers.
Syntaxe
La syntaxe actuellement standard est :
var request = indexedDB.deleteDatabase(nom);
Une version expérimentale permet de gérer des options (cf. ci-après) :
var request = indexedDB.deleteDatabase(nom, options);
Paramètres
nom
-
Le nom de la base de données qu'on souhaite supprimer. Tenter de supprimer une base de données qui n'existe pas ne déclenchera pas d'exception (contrairement à la tentative de suppression d'un magasin d'objets inexistant avec
IDBDatabase.deleteObjectStore()
qui déclenchera bien une exception). options
Non standard-
Dans Gecko, à partir de la version 26, il est possible d'inclure un paramètre pour indiquer le stockage de la base. La valeur peut être
permanent
(la valeur par défaut) outemporary
si on souhaite supprimer une base de données qui fait partie d'une mémoire partagée.
Valeur de retour
Cette méthode renvoie un objet IDBOpenDBRequest
sur lequel seront déclenchés les évènements relatifs à la requête.
Exemples
var DBDeleteRequest = window.indexedDB.deleteDatabase("toDoList");
DBDeleteRequest.onerror = function (event) {
console.log("Erreur lors de la suppression de la base");
};
DBDeleteRequest.onsuccess = function (event) {
console.log("Suppression de la base réussie");
console.log(event.result); // undefined
};
Spécifications
Specification |
---|
Indexed Database API 3.0 # ref-for-dom-idbfactory-deletedatabase① |
Compatibilité des navigateurs
BCD tables only load in the browser
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