IDBDatabase.createObjectStore()

The method takes the name of the store as well as a parameter object that lets you define important optional properties. You can use the property to uniquely identify individual objects in the store. As the property is an identifier, it should be unique to every object, and every object should have that property.

This method can be called only within a versionchange transaction.

Syntax

var objectStore = IDBDatabase.createObjectStore(name);
var objectStore = IDBDatabase.createObjectStore(name, options);

Parameters

name

The name of the new object store to be created. Note that it is possible to create an object store with an empty name.

optionalParameters Optional

An options object whose attributes are optional parameters to the method. It includes the following properties:

Attribute	Description
keyPath	The key path to be used by the new object store. If empty or not specified, the object store is created without a key path and uses out-of-line keys. You can also pass in an array as a keyPath.
autoIncrement	If true, the object store has a key generator. Defaults to false.

Unknown parameters are ignored.

Returns

IDBObjectStore

The newly created object store.

Exceptions

This method may raise a DOMException with a DOMError of one of the following types:

Example

 // Let us open our database
  var request = window.indexedDB.open("toDoList", 4);
  // This handler is called when a new version of the database
  // is created, either when one has not been created before
  // or when a new version number is submitted by calling
  // window.indexedDB.open().
  // This handler is only supported in recent browsers.
  request.onupgradeneeded = function(event) {
    var db = event.target.result;
    db.onerror = function(event) {
      note.innerHTML += '<li>Error loading database.</li>';
    };
    // Create an objectStore for this database
    var objectStore = db.createObjectStore("toDoList", { keyPath: "taskTitle" });
    // define what data items the objectStore will contain
    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>Object store created.</li>';
  };

Specification

Browser compatibility

See also

• Using IndexedDB
• Starting transactions: IDBDatabase
• Using transactions: IDBTransaction
• Setting a range of keys: IDBKeyRange
• Retrieving and making changes to your data: IDBObjectStore
• Using cursors: IDBCursor
• Reference example: To-do Notifications (view example live.)