W3cubDocs

/DOM

IDBObjectStore

The IDBObjectStore interface of the IndexedDB API represents an object store in a database. Records within an object store are sorted according to their keys. This sorting enables fast insertion, look-up, and ordered retrieval.

Note: This feature is available in Web Workers.

Properties

IDBObjectStore.indexNames Read only
A list of the names of indexes on objects in this object store.
IDBObjectStore.keyPath Read only
The key path of this object store. If this attribute is null, the application must provide a key for each modification operation.
IDBObjectStore.name
The name of this object store.
IDBObjectStore.transaction Read only
The IDBTransaction object to which this object store belongs.
IDBObjectStore.autoIncrement Read only
The value of the auto increment flag for this object store.

Methods

IDBObjectStore.add()
Returns an IDBRequest object, and, in a separate thread, creates a structured clone of the value, and stores the cloned value in the object store. This is for adding new records to an object store.
IDBObjectStore.clear()
Creates and immediately returns an IDBRequest object, and clears this object store in a separate thread. This is for deleting all current records out of an object store.
IDBObjectStore.count()
Returns an IDBRequest object, and, in a separate thread, returns the total number of records that match the provided key or IDBKeyRange. If no arguments are provided, it returns the total number of records in the store.
IDBObjectStore.createIndex()
Creates a new index during a version upgrade, returning a new IDBIndex object in the connected database.
IDBObjectStore.delete()
returns an IDBRequest object, and, in a separate thread, deletes the store object selected by the specified key. This is for deleting individual records out of an object store.
IDBObjectStore.deleteIndex()
Destroys the specified index in the connected database, used during a version upgrade.
IDBObjectStore.get()
Returns an IDBRequest object, and, in a separate thread, returns the store object store selected by the specified key. This is for retrieving specific records from an object store.
IDBObjectStore.getKey()
Returns an IDBRequest object, and, in a separate thread retrieves and returns the record key for the object in the object stored matching the specified parameter.
IDBObjectStore.getAll()
Returns an IDBRequest object retrieves all objects in the object store matching the specified parameter or all objects in the store if no parameters are given.
IDBObjectStore.getAllKeys()
Returns an IDBRequest object retrieves record keys for all objects in the object store matching the specified parameter or all objects in the store if no parameters are given.
IDBObjectStore.index()
Opens an index from this object store after which it can, for example, be used to return a sequence of records sorted by that index using a cursor.
IDBObjectStore.openCursor()
Returns an IDBRequest object, and, in a separate thread, returns a new IDBCursorWithValue object. Used for iterating through an object store by primary key with a cursor.
IDBObjectStore.openKeyCursor()
Returns an IDBRequest object, and, in a separate thread, returns a new IDBCursor. Used for iterating through an object store with a key.
IDBObjectStore.put()
Returns an IDBRequest object, and, in a separate thread, creates a structured clone of the value, and stores the cloned value in the object store. This is for updating existing records in an object store when the transaction's mode is readwrite.

Example

This example shows a variety of different uses of object stores, from updating the data structure with IDBObjectStore.createIndex inside an onupgradeneeded function, to adding a new item to our object store with IDBObjectStore.add. 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 db.
  db = DBOpenRequest.result;
};

// This event handles the event whereby a new version of
// the database needs to be created Either one has not
// been created before, or a new version number has been
// submitted via the window.indexedDB.open line above
DBOpenRequest.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>';
};

// Create a new item to add in to the object store
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");
// make a request to add our newItem object to the object store
var objectStoreRequest = objectStore.add(newItem[0]);        

objectStoreRequest.onsuccess = function(event) {
  note.innerHTML += '<li>Request successful .</li>';
}

Specifications

Browser compatibilityUpdate compatibility data on GitHub

Desktop
Chrome Edge Firefox Internet Explorer Opera Safari
Basic support 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
Available in workers Yes Yes 37 ? Yes ?
autoIncrement 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
indexNames 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
12 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
keyPath 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
12 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
name 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
12 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
transaction 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
12 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
add 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
12 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
clear 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
12 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
count 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
12 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
createIndex 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
12 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
delete 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
12 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
deleteIndex 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
12 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
get 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
12 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
getAll 48 ? 44
Disabled
44
Disabled
Disabled From version 44: this feature is behind the dom.indexedDB.experimental preference. To change preferences in Firefox, visit about:config.
? 35 10.1
getAllKeys 48 ? 44 ? 35 10.1
getKey 48 ? 51 ? 45 10.1
index 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
12 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
openCursor 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
12 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
openKeyCursor 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 44
Disabled
44
Disabled
Disabled From version 44: this feature is behind the dom.indexedDB.experimental preference. To change preferences in Firefox, visit about:config.
10
10
partial
15 7
put 24
24
23 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
12 16
16
10 — 16
Prefixed
Prefixed Requires the vendor prefix: moz
10
10
partial
15 7
Mobile
Android webview Chrome for Android Edge Mobile Firefox for Android Opera for Android iOS Safari Samsung Internet
Basic support Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
Available in workers Yes Yes Yes 37 Yes ? Yes
autoIncrement Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
indexNames Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
keyPath Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
name Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
transaction Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
add Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
clear Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
count Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
createIndex Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
delete Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
deleteIndex Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
get Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
getAll 48 48 ? 48 35 10.1 5.0
getAllKeys 48 48 ? 48 35 10.1 5.0
getKey 48 48 ? 58 45 10.1 5.0
index Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
openCursor Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
openKeyCursor Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit
put Yes
Yes
? — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
25
25
25 — 57
Prefixed
Prefixed Requires the vendor prefix: webkit
Yes 22 22 8 Yes
Yes
? — 7.0
Prefixed
Prefixed Requires the vendor prefix: webkit

See also

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore