The createObjectStore()
method of the IDBDatabase
interface creates and returns a new object store or index.
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.
Note: This feature is available in Web Workers.
Syntax
IDBDatabase.createObjectStore(name); 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
OptionalAn 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 tofalse
.Unknown parameters are ignored.
Returns
A new IDBObjectStore
.
Exceptions
This method may raise a DOMException
with a DOMError
of one of the following types:
Exception | Description |
---|---|
InvalidStateError
|
Occurs if the method was not called from a versionchange transaction callback. For older WebKit browsers, you must call first.
|
TransactionInactiveError
|
Occurs if a request is made on a source database that doesn't exist (e.g. has been deleted or removed.) In Firefox previous to version 41, an InvalidStateError was raised in this case as well, which was misleading; this has now been fixed (see bug 1176165.)
|
ConstraintError
|
An object store with the given name (based on case-sensitive comparison) already exists in the connected database. |
InvalidAccessError
|
If autoIncrement is set to true and keyPath is either an empty string or an array containing an empty string.
|
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
Specification | Status | Comment |
Indexed Database API 2.0The definition of 'createObjectStore()' in that specification. | Recommendation | |
Indexed Database API DraftThe definition of 'createObjectStore()' in that specification. | Recommendation |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
createObjectStore
|
Chrome Full support 24 Full support 24 No support 23 — 24 Prefixed' Implemented with the vendor prefix: webkit |
Edge
Full support 12 |
Firefox Full support 16 Full support 16 No support 10 — 16 Prefixed' Implemented with the vendor prefix: moz |
IE
Partial support 10 |
Opera
Full support 15 |
Safari
Full support 7 |
WebView Android
Full support Yes |
Chrome Android
Full support 25 |
Firefox Android
Full support 22 |
Opera Android
Full support 14 |
Safari iOS
Full support 8 |
Samsung Internet Android
Full support 1.5 |
Legend
- Full support
- Full support
- Partial support
- Partial support
- Requires a vendor prefix or different name for use.'
- Requires a vendor prefix or different name for use.
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 ([[../../../../../../../mdn.github.io/to-do-notifications/index|view example live]].)
IDBDatabase.createObjectStore() by Mozilla Contributors is licensed under CC-BY-SA 2.5.