IDBObjectStore.name

The name property of the IDBObjectStore interface indicates the name of this object store.

Note: This feature is available in Web Workers.

Syntax

IDBObjectStore.name = myNewName;
var myObjectStoreName = IDBObjectStore.name;

Value

A DOMString containing the object store's name.

Exceptions

There are a several exceptions which can occur when you attempt to change an object store's name.

InvalidStateError
Either the object store has been deleted or the current transaction is not an upgrade transaction; you can only rename indexes during upgrade transactions; that is, when the mode is "versionchange".
TransactionInactiveError
The current transaction is not active.
ConstraintError
An object store is already using the specified name.

Example

In the following code snippet, we open a read/write transaction on our database and add some data to an object store using add(). After the object store has been created, we log objectStore.name to the console. For a full working example, see our To-do Notifications app (view example live.)

// Let us open our database
var DBOpenRequest = window.indexedDB.open("toDoList", 4);

DBOpenRequest.onsuccess = function(event) {
  note.innerHTML += '<li>Database initialised.</li>';
    
  // store the result of opening the database in the db variable.
  // This is used a lot below
  db = DBOpenRequest.result;
    
  // Run the addData() function to add the data to the database
  addData();
};

function addData() {
  // Create a new object ready to insert into the IDB
  var newItem = [ { taskTitle: "Walk dog", hours: 19, minutes: 30, day: 24, month: "December", year: 2013, notified: "no" } ];

  // open a read/write db transaction, ready for adding the data
  var transaction = db.transaction(["toDoList"], "readwrite");

  // report on the success of the transaction completing, when everything is done
  transaction.oncomplete = function(event) {
    note.innerHTML += '<li>Transaction completed.</li>';
  };

  transaction.onerror = function(event) {
  note.innerHTML += '<li>Transaction not opened due to error. Duplicate items not allowed.</li>';
  };

  // create an object store on the transaction
  var objectStore = transaction.objectStore("toDoList");
  console.log(objectStore.name);

  // Make a request to add our newItem object to the object store
  var objectStoreRequest = objectStore.add(newItem[0]);

  objectStoreRequest.onsuccess = function(event) {
    // report the success of our request
    note.innerHTML += '<li>Request successful.</li>';
  };
};

Specification

Specification Status Comment
Indexed Database API
The definition of 'name' in that specification.
Recommendation  
Indexed Database API 2.0
The definition of 'name' in that specification.
Editor's Draft  

Browser compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 23webkit
24 (unprefixed)
(Yes) 10 moz
16 (16)
10, partial 15 7.1
Available in workers (Yes) ? 37 (37) ? (Yes) ?
Renaming through name setter (Yes) ? 49 (49) ? (Yes) ?
Indexed Database 2.0 58 ? ? ? 45 ?
Feature Android Webview Chrome for Android Edge Firefox Mobile (Gecko) Firefox OS IE Phone Opera Mobile Safari Mobile
Basic support (Yes) (Yes) (Yes) 22.0 (22) 1.0.1 10 22 8
Available in workers (Yes) (Yes) ? 37.0 (37) (Yes) ? (Yes) ?
Renaming through name setter (Yes) (Yes) ? 49.0 (49) ? ? (Yes) ?
Indexed Database 2.0 58 58 ? ? ? ? 45 ?

See also

Document Tags and Contributors

 Contributors to this page: chrisdavidmills, jpmedley, libbymc, Sheppy, fscholz
 Last updated by: chrisdavidmills,