IDBObjectStore.keyPath

La propriété keyPath de l'interface IDBObjectStore renvoie le nom de la clé du magasin d'objet relié.

Le nom de la clé d'un magasin d'objet est optionnel, si il y en à un on dit qu'il utilise des clés internes. Sinon on dit qu'il utilise des clés externes. Les clés internes comme externes peuvent être incrémente automatiquement si le magasin d'objets à un générateur.

Syntaxe

var mykeyPath = objectStore.keyPath;

Valeur

Tout type de valeur.

Exemple

Dans le code suivant, on ouvre une connexion à la base de donnée. Sur cette connexion on démarre une transaction en lecture/écriture pour avoir un accès au magasin d'objet "toDoList" dans lequel on ajoute un enregistrement.

La propriété keyPath de l'accès au magasin d'objet sert à affiché le nom de la clé de ce magasin d'objets sur la console.

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

DBOpenRequest.onsuccess = function(event) {
	note.innerHTML += '<li>Connexion établie.</li>'; 
  
	//Affecte la connexion à la variable db. 
	db = DBOpenRequest.result; 

	// Exécutez la fonction addData () pour ajouter un enregistrement au magasin d'objet
	addData(); 
};
function addData() { 
	// un nouvel objet prêt à être emmagasiné
	newItem = [ { taskTitle: "Walk dog", hours: 19, minutes: 30, day: 24, month: "December", year: 2013, notified: "no" } ]; 
	
	// ouvre une transaction de lecture / écriture  prête au traitement des données sur la connexion
	var transaction = db.transaction(["toDoList"], "readwrite"); 
	
	// en cas de succès de l'ouverture de la transaction 
	transaction.oncomplete = function(event) { 
		note.innerHTML += '<li>Transaction complété : modification de la base de données terminée.</li>'; 
	}; 
	// en  cas d'échec de l'ouverture de la transaction 
	transaction.onerror = function(event) { 
		note.innerHTML += '<li>L\'erreur: "' + transaction.error +'" c\'est produite échec de la transaction.</li>';  
	}; 
	
	// ouvre l'accès au un magasin "toDoList" de la transaction
	var objectStore = transaction.objectStore("toDoList"); 
	
//->Affiche le nom de la clè du magasin d'objet
    console.log(objectStore.keyPath);

	// Ajoute un enregistrement
	var objectStoreRequest = objectStore.add(newItem[0]); 
	objectStoreRequest.onsuccess = function(event) { 
		// signale l'ajout de l'enregistrement
		note.innerHTML += '<li>Nouvel élément emmagasiné.</li>'; 
	};
 };
 

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

Spécification

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.)