Cette page a été traduite à partir de l'anglais par la communauté.Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.
IDBFactory.open()
Baseline Widely available
Cette fonctionnalité est bien établie et fonctionne sur de nombreux appareils et versions de navigateurs. Elle est disponible sur tous les navigateurs depuis septembre 2021.
La méthodeopen() de l'interfaceIDBFactory lance une requête pour ouvrir uneconnexion à une base de données.
La méthode renvoie immédiatement un objetIDBOpenDBRequest puis effectue l'opération d'ouverture de façon asynchrone. Si l'opération réussit, un évènementsuccess sera éms sur l'objetIDBOpenDBRequest renvoyé par la méthode, et la propriétéresult de l'évènement aura la valeur de l'objetIDBDatabase associé à la connexion.
Si une erreur se produit lors de la connexion, un évènementerror sera émis sur l'objetIDBOpenDBRequest renvoyé par la méthode.
Cette méthode peut également émettre les évènementsupgradeneeded,blocked ouversionchange.
Note : Cette fonctionnalité est disponible via lesWeb Workers.
Dans cet article
Syntaxe
La syntaxe standard est la suivante :
var IDBOpenDBRequest = indexedDB.open(nom);var IDBOpenDBRequest = indexedDB.open(nom, version);Paramètres
nomLe nom de la base de données qu'on souhaite ouvrir.
versionFacultatifParamètre optionnel qui représente la version de la base de données qu'on veut ouvrir. Si ce paramètre n'est pas fourni et que la base de données existe, une connexion sera ouverte sans changer la version de la base de données. Si ce paramètre n'est pas fourni est que la base de données n'existe pas, elle sera créée avec une version
1.
Objet options expérimental de Gecko
options(versionetstorage)FacultatifObsolèteDans Gecko, à partir dela version 26, il est possible de passer en paramètre un objet
optionsnon standard, qui contienne le numéro de version de la base de données (équivalent donc au paramètreversiondéfinit ci-avant), et également une valeurstoragequi décrit si on souhaite utiliser un stockage permanent (avec la valeurpersistent) ou un stockage temporaire (avec la valeurtemporary).Attention :L'attribut
storageest déprécié et sera prochainement retiré de Gecko. Vous devriez utiliserStorageManager.persist()à la place pour obtenir un stockage persistant.
Note :Vous pouvez consulter l'articleles limites de stockage du navigateur et les critères d'éviction pour en savoir plus sur les différents types de stockage disponibles et la façon dont Firefox gère les données côté client.
Valeur de retour
Un objetIDBOpenDBRequest sur lequel sont déclenchés les différents évènements liés à cette requête.
Exceptions
Cette méthode peut lever uneDOMException de type suivant :
| Exception | Description |
|---|---|
TypeError | La valeur de version est zéro ou un nombre négatif ou n'est pas un nombre. |
Exemples
Voici un exemple d'ouverture de la base de donnéestoDoList en utilisant la syntaxe standard et le paramètreversion :
var request = window.indexedDB.open("toDoList", 4);Dans le fragment de code qui suit, on effectue une requête pour ouvrir une base de données et on inclut des gestionnaires d'évènements pour gérer la réussite ou l'échec de l'ouverture. Pour consulter un exemple fonctionnel complet, vous pouvez étudier notre applicationTo-do Notifications (cf. l'exemplelive).
var note = document.querySelector("ul");window.indexedDB = window.indexedDB || window.mozIndexedDB || window.webkitIndexedDB || window.msIndexedDB;// NE PAS utiliser "var indexedDB = ..." si on n’est pas dans une fonction.// On pourrait avoir besoin de références vers quelques objets window.IDB* :window.IDBTransaction = window.IDBTransaction || window.webkitIDBTransaction || window.msIDBTransaction;window.IDBKeyRange = window.IDBKeyRange || window.webkitIDBKeyRange || window.msIDBKeyRange;// Mozilla n’a jamais préfixé ces objets, donc on n’a pas besoin de window.mozIDB*// On ouvre la version 4 de la base de donnéesvar DBOpenRequest = window.indexedDB.open("toDoList", 4);// On ajoute deux gestionnaires d'évènements// Le premier utilisé en cas d'échecDBOpenRequest.onerror = function (event) { note.innerHTML += "<li>Erreur lors du chargement de la base.</li>";};// Et le second en cas de réussiteDBOpenRequest.onsuccess = function (event) { note.innerHTML += "<li>Base de données initialisée.</li>"; // On stocke le résultat de l'ouverture dans la // variable db qui sera utilisée par la suite // pour d'autres opérations db = DBOpenRequest.result;};Spécifications
| Specification |
|---|
| Indexed Database API 3.0> # ref-for-dom-idbfactory-open②> |
Compatibilité des navigateurs
Voir aussi
- Utiliser 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