elemental.html

Interface IDBDatabase

All Superinterfaces:

EventTarget

All Known Implementing Classes:

JsIDBDatabase

public interface IDBDatabase
extends EventTarget

The IDBDatabase interface of the IndexedDB API provides asynchronous access to a connection to a database. Use it to create, manipulate, and delete objects in that database. The interface also provides the only way to get a transaction and manage versions on that database.

Inherits from: EventTarget

Method Summary

Modifier and Type	Method and Description
EventRemover	addEventListener(String type, EventListener listener) Register an event handler of a specific event type on the EventTarget.
EventRemover	addEventListener(String type, EventListener listener, boolean useCapture) Register an event handler of a specific event type on the EventTarget.
void	close() Returns immediately and closes the connection in a separate thread.
IDBObjectStore	createObjectStore(String name) Creates and returns a new object store or index.
IDBObjectStore	createObjectStore(String name, Mappable options) Creates and returns a new object store or index.
void	deleteObjectStore(String name) Destroys the object store with the given name in the connected database, along with any indexes that reference it.
boolean	dispatchEvent(Event evt) Dispatch an event to this EventTarget.
String	getName() Name of the connected database.
Indexable	getObjectStoreNames() A list of the names of the object stores currently in the connected database.
EventListener	getOnabort()
EventListener	getOnerror()
EventListener	getOnversionchange()
String	getVersion() The version of the connected database.
void	removeEventListener(String type, EventListener listener) Removes an event listener from the EventTarget.
void	removeEventListener(String type, EventListener listener, boolean useCapture) Removes an event listener from the EventTarget.
void	setOnabort(EventListener arg)
void	setOnerror(EventListener arg)
void	setOnversionchange(EventListener arg)
IDBTransaction	transaction(Indexable storeNames) Immediately returns an IDBTransaction object, and starts a transaction in a separate thread.
IDBTransaction	transaction(Indexable storeNames, int mode) Immediately returns an IDBTransaction object, and starts a transaction in a separate thread.
IDBTransaction	transaction(Indexable storeNames, String mode) Immediately returns an IDBTransaction object, and starts a transaction in a separate thread.
IDBTransaction	transaction(String storeName) Immediately returns an IDBTransaction object, and starts a transaction in a separate thread.
IDBTransaction	transaction(String storeName, int mode) Immediately returns an IDBTransaction object, and starts a transaction in a separate thread.
IDBTransaction	transaction(String storeName, String mode) Immediately returns an IDBTransaction object, and starts a transaction in a separate thread.

Method Detail

getName

String getName()

Name of the connected database.

getObjectStoreNames

Indexable getObjectStoreNames()

A list of the names of the object stores currently in the connected database.

getOnabort

EventListener getOnabort()

setOnabort

void setOnabort(EventListener arg)

getOnerror

EventListener getOnerror()

setOnerror

void setOnerror(EventListener arg)

getOnversionchange

EventListener getOnversionchange()

setOnversionchange

void setOnversionchange(EventListener arg)

getVersion

String getVersion()

The version of the connected database. When a database is first created, this attribute is the empty string.

addEventListener

EventRemover addEventListener(String type,
                              EventListener listener)

Description copied from interface: EventTarget

Register an event handler of a specific event type on the EventTarget.

Specified by:

addEventListener in interface EventTarget

addEventListener

EventRemover addEventListener(String type,
                              EventListener listener,
                              boolean useCapture)

Description copied from interface: EventTarget

Register an event handler of a specific event type on the EventTarget.

Specified by:

addEventListener in interface EventTarget

close

void close()

Returns immediately and closes the connection in a separate thread. The connection is not actually closed until all transactions created using this connection are complete. No new transactions can be created for this connection once this method is called. Methods that create transactions throw an exception if a closing operation is pending.

void close();

createObjectStore

IDBObjectStore createObjectStore(String name)

Creates and returns a new object store or index. The method takes the name of the store as well as a parameter object. The parameter object 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.

But before you can create any object store or index, you must first call the setVersion() method.

Parameters

name

The name of the new object store.

optionalParameters

Warning: The latest draft of the specification changed this to IDBDatabaseOptionalParameters, which is not yet recognized by any browser

Optional. 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.
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 can raise an IDBDatabaseException with the following codes:

Exception	Description
NOT_ALLOWED_ERR	The method was not called from a VERSION_CHANGE transaction callback. You must call setVersion() first.
CONSTRAINT_ERR	An object store with the given name (based on case-sensitive comparison) already exists in the connected database.
NON_TRANSIENT_ERR	optionalParameters has attributes other than keyPath and autoIncrement.

createObjectStore

IDBObjectStore createObjectStore(String name,
                                 Mappable options)

Creates and returns a new object store or index. The method takes the name of the store as well as a parameter object. The parameter object 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.

But before you can create any object store or index, you must first call the setVersion() method.

Parameters

name

The name of the new object store.

optionalParameters

Warning: The latest draft of the specification changed this to IDBDatabaseOptionalParameters, which is not yet recognized by any browser

Optional. 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.
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 can raise an IDBDatabaseException with the following codes:

Exception	Description
NOT_ALLOWED_ERR	The method was not called from a VERSION_CHANGE transaction callback. You must call setVersion() first.
CONSTRAINT_ERR	An object store with the given name (based on case-sensitive comparison) already exists in the connected database.
NON_TRANSIENT_ERR	optionalParameters has attributes other than keyPath and autoIncrement.

deleteObjectStore

void deleteObjectStore(String name)

Destroys the object store with the given name in the connected database, along with any indexes that reference it.

As with createObjectStore(), this method can be called only within a VERSION_CHANGE transaction. So you must call the setVersion() method first before you can remove any object store or index.

Parameters

name

The name of the data store to delete.

Returns

void

Exceptions

This method can raise an IDBDatabaseException with the following codes:

Exception	Description
NOT_ALLOWED_ERR	The method was not called from a VERSION_CHANGE transaction callback. You must call setVersion() first.
NOT_FOUND_ERR	You are trying to delete an object store that does not exist. Names are case sensitive.

dispatchEvent

boolean dispatchEvent(Event evt)

Description copied from interface: EventTarget

Dispatch an event to this EventTarget.

Specified by:

dispatchEvent in interface EventTarget

removeEventListener

void removeEventListener(String type,
                         EventListener listener)

Description copied from interface: EventTarget

Removes an event listener from the EventTarget.

Specified by:

removeEventListener in interface EventTarget

removeEventListener

void removeEventListener(String type,
                         EventListener listener,
                         boolean useCapture)

Description copied from interface: EventTarget

Removes an event listener from the EventTarget.

Specified by:

removeEventListener in interface EventTarget

transaction

IDBTransaction transaction(Indexable storeNames)

Immediately returns an IDBTransaction object, and starts a transaction in a separate thread. The method returns a transaction object (IDBTransaction) containing the objectStore() method, which you can use to access your object store.

Parameters

storeNames

The names of object stores and indexes that are in the scope of the new transaction. Specify only the object stores that you need to access.

mode

Optional. The types of access that can be performed in the transaction. Transactions are opened in one of three modes: READ_ONLY, READ_WRITE, and VERSION_CHANGE. If you don't provide the parameter, the default access mode is READ_ONLY. To avoid slowing things down, don't open a READ_WRITE transaction, unless you actually need to write into the database.

Sample code

To start a transaction with the following scope, you can use the code snippets in the table. As noted earlier:

• Add prefixes to the methods in WebKit browsers, (that is, instead of IDBTransaction.READ_ONLY, use webkitIDBTransaction.READ_ONLY).
• The default mode is READ_ONLY, so you don't really have to specify it. Of course, if you need to write into the object store, you can open the transaction in the READ_WRITE mode.

Scope	Code
Single object store	var transaction = db.transaction(['my-store-name'], IDBTransaction.READ_ONLY); Alternatively: var transaction = db.transaction('my-store-name', IDBTransaction.READ_ONLY);
Multiple object stores	var transaction = db.transaction(['my-store-name', 'my-store-name2'], IDBTransaction.READ_ONLY);
All object stores	var transaction = db.transaction(db.objectStoreNames, IDBTransaction.READ_ONLY); You cannot pass an empty array into the storeNames parameter, such as in the following: var transaction = db.transaction([], IDBTransaction.READ_ONLY);. Warning: Accessing all obejct stores under the READ_WRITE mode means that you can run only that transaction. You cannot have writing transactions with overlapping scopes.

Returns

IDBTransaction

The transaction object.

Exceptions

This method can raise an IDBDatabaseException with the following codes:

Exception	Description
NOT_ALLOWED_ERR	The error is thrown for one of two reasons: The close() method has been called on this IDBDatabase instance. The object store has been deleted or removed.
NOT_FOUND_ERR	One of the object stores doesn't exist in the connected database.

transaction

IDBTransaction transaction(Indexable storeNames,
                           String mode)

Immediately returns an IDBTransaction object, and starts a transaction in a separate thread. The method returns a transaction object (IDBTransaction) containing the objectStore() method, which you can use to access your object store.

Parameters

storeNames

The names of object stores and indexes that are in the scope of the new transaction. Specify only the object stores that you need to access.

mode

Optional. The types of access that can be performed in the transaction. Transactions are opened in one of three modes: READ_ONLY, READ_WRITE, and VERSION_CHANGE. If you don't provide the parameter, the default access mode is READ_ONLY. To avoid slowing things down, don't open a READ_WRITE transaction, unless you actually need to write into the database.

Sample code

To start a transaction with the following scope, you can use the code snippets in the table. As noted earlier:

• Add prefixes to the methods in WebKit browsers, (that is, instead of IDBTransaction.READ_ONLY, use webkitIDBTransaction.READ_ONLY).
• The default mode is READ_ONLY, so you don't really have to specify it. Of course, if you need to write into the object store, you can open the transaction in the READ_WRITE mode.

Scope	Code
Single object store	var transaction = db.transaction(['my-store-name'], IDBTransaction.READ_ONLY); Alternatively: var transaction = db.transaction('my-store-name', IDBTransaction.READ_ONLY);
Multiple object stores	var transaction = db.transaction(['my-store-name', 'my-store-name2'], IDBTransaction.READ_ONLY);
All object stores	var transaction = db.transaction(db.objectStoreNames, IDBTransaction.READ_ONLY); You cannot pass an empty array into the storeNames parameter, such as in the following: var transaction = db.transaction([], IDBTransaction.READ_ONLY);. Warning: Accessing all obejct stores under the READ_WRITE mode means that you can run only that transaction. You cannot have writing transactions with overlapping scopes.

Returns

IDBTransaction

The transaction object.

Exceptions

This method can raise an IDBDatabaseException with the following codes:

Exception	Description
NOT_ALLOWED_ERR	The error is thrown for one of two reasons: The close() method has been called on this IDBDatabase instance. The object store has been deleted or removed.
NOT_FOUND_ERR	One of the object stores doesn't exist in the connected database.

transaction

IDBTransaction transaction(String storeName)

Immediately returns an IDBTransaction object, and starts a transaction in a separate thread. The method returns a transaction object (IDBTransaction) containing the objectStore() method, which you can use to access your object store.

Parameters

storeNames

The names of object stores and indexes that are in the scope of the new transaction. Specify only the object stores that you need to access.

mode

Optional. The types of access that can be performed in the transaction. Transactions are opened in one of three modes: READ_ONLY, READ_WRITE, and VERSION_CHANGE. If you don't provide the parameter, the default access mode is READ_ONLY. To avoid slowing things down, don't open a READ_WRITE transaction, unless you actually need to write into the database.

Sample code

To start a transaction with the following scope, you can use the code snippets in the table. As noted earlier:

• Add prefixes to the methods in WebKit browsers, (that is, instead of IDBTransaction.READ_ONLY, use webkitIDBTransaction.READ_ONLY).
• The default mode is READ_ONLY, so you don't really have to specify it. Of course, if you need to write into the object store, you can open the transaction in the READ_WRITE mode.

Scope	Code
Single object store	var transaction = db.transaction(['my-store-name'], IDBTransaction.READ_ONLY); Alternatively: var transaction = db.transaction('my-store-name', IDBTransaction.READ_ONLY);
Multiple object stores	var transaction = db.transaction(['my-store-name', 'my-store-name2'], IDBTransaction.READ_ONLY);
All object stores	var transaction = db.transaction(db.objectStoreNames, IDBTransaction.READ_ONLY); You cannot pass an empty array into the storeNames parameter, such as in the following: var transaction = db.transaction([], IDBTransaction.READ_ONLY);. Warning: Accessing all obejct stores under the READ_WRITE mode means that you can run only that transaction. You cannot have writing transactions with overlapping scopes.

Returns

IDBTransaction

The transaction object.

Exceptions

This method can raise an IDBDatabaseException with the following codes:

Exception	Description
NOT_ALLOWED_ERR	The error is thrown for one of two reasons: The close() method has been called on this IDBDatabase instance. The object store has been deleted or removed.
NOT_FOUND_ERR	One of the object stores doesn't exist in the connected database.

transaction

IDBTransaction transaction(String storeName,
                           String mode)

Immediately returns an IDBTransaction object, and starts a transaction in a separate thread. The method returns a transaction object (IDBTransaction) containing the objectStore() method, which you can use to access your object store.

Parameters

storeNames

The names of object stores and indexes that are in the scope of the new transaction. Specify only the object stores that you need to access.

mode

Optional. The types of access that can be performed in the transaction. Transactions are opened in one of three modes: READ_ONLY, READ_WRITE, and VERSION_CHANGE. If you don't provide the parameter, the default access mode is READ_ONLY. To avoid slowing things down, don't open a READ_WRITE transaction, unless you actually need to write into the database.

Sample code

To start a transaction with the following scope, you can use the code snippets in the table. As noted earlier:

• Add prefixes to the methods in WebKit browsers, (that is, instead of IDBTransaction.READ_ONLY, use webkitIDBTransaction.READ_ONLY).
• The default mode is READ_ONLY, so you don't really have to specify it. Of course, if you need to write into the object store, you can open the transaction in the READ_WRITE mode.

Scope	Code
Single object store	var transaction = db.transaction(['my-store-name'], IDBTransaction.READ_ONLY); Alternatively: var transaction = db.transaction('my-store-name', IDBTransaction.READ_ONLY);
Multiple object stores	var transaction = db.transaction(['my-store-name', 'my-store-name2'], IDBTransaction.READ_ONLY);
All object stores	var transaction = db.transaction(db.objectStoreNames, IDBTransaction.READ_ONLY); You cannot pass an empty array into the storeNames parameter, such as in the following: var transaction = db.transaction([], IDBTransaction.READ_ONLY);. Warning: Accessing all obejct stores under the READ_WRITE mode means that you can run only that transaction. You cannot have writing transactions with overlapping scopes.

Returns

IDBTransaction

The transaction object.

Exceptions

This method can raise an IDBDatabaseException with the following codes:

Exception	Description
NOT_ALLOWED_ERR	The error is thrown for one of two reasons: The close() method has been called on this IDBDatabase instance. The object store has been deleted or removed.
NOT_FOUND_ERR	One of the object stores doesn't exist in the connected database.

transaction

IDBTransaction transaction(Indexable storeNames,
                           int mode)

Immediately returns an IDBTransaction object, and starts a transaction in a separate thread. The method returns a transaction object (IDBTransaction) containing the objectStore() method, which you can use to access your object store.

Parameters

storeNames

The names of object stores and indexes that are in the scope of the new transaction. Specify only the object stores that you need to access.

mode

Optional. The types of access that can be performed in the transaction. Transactions are opened in one of three modes: READ_ONLY, READ_WRITE, and VERSION_CHANGE. If you don't provide the parameter, the default access mode is READ_ONLY. To avoid slowing things down, don't open a READ_WRITE transaction, unless you actually need to write into the database.

Sample code

To start a transaction with the following scope, you can use the code snippets in the table. As noted earlier:

• Add prefixes to the methods in WebKit browsers, (that is, instead of IDBTransaction.READ_ONLY, use webkitIDBTransaction.READ_ONLY).
• The default mode is READ_ONLY, so you don't really have to specify it. Of course, if you need to write into the object store, you can open the transaction in the READ_WRITE mode.

Scope	Code
Single object store	var transaction = db.transaction(['my-store-name'], IDBTransaction.READ_ONLY); Alternatively: var transaction = db.transaction('my-store-name', IDBTransaction.READ_ONLY);
Multiple object stores	var transaction = db.transaction(['my-store-name', 'my-store-name2'], IDBTransaction.READ_ONLY);
All object stores	var transaction = db.transaction(db.objectStoreNames, IDBTransaction.READ_ONLY); You cannot pass an empty array into the storeNames parameter, such as in the following: var transaction = db.transaction([], IDBTransaction.READ_ONLY);. Warning: Accessing all obejct stores under the READ_WRITE mode means that you can run only that transaction. You cannot have writing transactions with overlapping scopes.

Returns

IDBTransaction

The transaction object.

Exceptions

This method can raise an IDBDatabaseException with the following codes:

Exception	Description
NOT_ALLOWED_ERR	The error is thrown for one of two reasons: The close() method has been called on this IDBDatabase instance. The object store has been deleted or removed.
NOT_FOUND_ERR	One of the object stores doesn't exist in the connected database.

transaction

IDBTransaction transaction(String storeName,
                           int mode)

Immediately returns an IDBTransaction object, and starts a transaction in a separate thread. The method returns a transaction object (IDBTransaction) containing the objectStore() method, which you can use to access your object store.

Parameters

storeNames

The names of object stores and indexes that are in the scope of the new transaction. Specify only the object stores that you need to access.

mode

Optional. The types of access that can be performed in the transaction. Transactions are opened in one of three modes: READ_ONLY, READ_WRITE, and VERSION_CHANGE. If you don't provide the parameter, the default access mode is READ_ONLY. To avoid slowing things down, don't open a READ_WRITE transaction, unless you actually need to write into the database.

Sample code

To start a transaction with the following scope, you can use the code snippets in the table. As noted earlier:

• Add prefixes to the methods in WebKit browsers, (that is, instead of IDBTransaction.READ_ONLY, use webkitIDBTransaction.READ_ONLY).
• The default mode is READ_ONLY, so you don't really have to specify it. Of course, if you need to write into the object store, you can open the transaction in the READ_WRITE mode.

Scope	Code
Single object store	var transaction = db.transaction(['my-store-name'], IDBTransaction.READ_ONLY); Alternatively: var transaction = db.transaction('my-store-name', IDBTransaction.READ_ONLY);
Multiple object stores	var transaction = db.transaction(['my-store-name', 'my-store-name2'], IDBTransaction.READ_ONLY);
All object stores	var transaction = db.transaction(db.objectStoreNames, IDBTransaction.READ_ONLY); You cannot pass an empty array into the storeNames parameter, such as in the following: var transaction = db.transaction([], IDBTransaction.READ_ONLY);. Warning: Accessing all obejct stores under the READ_WRITE mode means that you can run only that transaction. You cannot have writing transactions with overlapping scopes.

Returns

IDBTransaction

The transaction object.

Exceptions

This method can raise an IDBDatabaseException with the following codes:

Exception	Description
NOT_ALLOWED_ERR	The error is thrown for one of two reasons: The close() method has been called on this IDBDatabase instance. The object store has been deleted or removed.
NOT_FOUND_ERR	One of the object stores doesn't exist in the connected database.