akasha.idb

Class IDBDatabase

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.idb.IDBDatabase

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="IDBDatabase")
public class IDBDatabase
extends EventTarget

The IDBDatabase interface of the IndexedDB API provides a connection to a database; you can use an IDBDatabase object to open a transaction on your database then create, manipulate, and delete objects (data) in that database. The interface provides the only way to get and manage versions of the database.

See Also:

IDBDatabase - MDN, (Indexed DB 3.0) # database-interface

Field Summary

Fields

Modifier and Type	Field and Description
EventHandler	onabort The onabort event handler of the IDBDatabase interface handles the abort event, fired when a transaction is aborted and bubbles up to the connection object.
EventHandler	onclose A function which is called when the close event is fired.
EventHandler	onerror The onerror event handler of the IDBDatabase interface handles the error event, fired when a request returns an error and bubbles up to the connection object.
EventHandler	onversionchange This example shows an IDBOpenDBRequest.onupgradeneeded block that creates a new object store; it also includes onerror and onabort functions to handle non-success cases, and an onversionchange function to notify when a database structure change has occurred.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IDBDatabase()

Method Summary

Modifier and Type	Method and Description
void	addAbortListener(EventListener callback)
void	addAbortListener(EventListener callback, AddEventListenerOptions options)
void	addAbortListener(EventListener callback, boolean useCapture)
void	addCloseListener(EventListener callback)
void	addCloseListener(EventListener callback, AddEventListenerOptions options)
void	addCloseListener(EventListener callback, boolean useCapture)
void	addErrorListener(EventListener callback)
void	addErrorListener(EventListener callback, AddEventListenerOptions options)
void	addErrorListener(EventListener callback, boolean useCapture)
void	addVersionchangeListener(EventListener callback)
void	addVersionchangeListener(EventListener callback, AddEventListenerOptions options)
void	addVersionchangeListener(EventListener callback, boolean useCapture)
void	close() The connection is not actually closed until all transactions created using this connection are complete.
IDBObjectStore	createObjectStore(java.lang.String name) The method takes the name of the store as well as a parameter object that lets you define important optional properties.
IDBObjectStore	createObjectStore(java.lang.String name, IDBObjectStoreParameters options) The method takes the name of the store as well as a parameter object that lets you define important optional properties.
void	deleteObjectStore(java.lang.String name) As with IDBDatabase.createObjectStore, this method can be called only within a versionchange transaction.
java.lang.String	name() A DOMString containing the name of the connected database.
DOMStringList	objectStoreNames() A DOMStringList containing a list of the names of the object stores currently in the connected database.
void	removeAbortListener(EventListener callback)
void	removeAbortListener(EventListener callback, boolean useCapture)
void	removeAbortListener(EventListener callback, EventListenerOptions options)
void	removeCloseListener(EventListener callback)
void	removeCloseListener(EventListener callback, boolean useCapture)
void	removeCloseListener(EventListener callback, EventListenerOptions options)
void	removeErrorListener(EventListener callback)
void	removeErrorListener(EventListener callback, boolean useCapture)
void	removeErrorListener(EventListener callback, EventListenerOptions options)
void	removeVersionchangeListener(EventListener callback)
void	removeVersionchangeListener(EventListener callback, boolean useCapture)
void	removeVersionchangeListener(EventListener callback, EventListenerOptions options)
IDBTransaction	transaction(JsArray<java.lang.String> storeNames) An IDBTransaction object.
IDBTransaction	transaction(JsArray<java.lang.String> storeNames, java.lang.String mode) An IDBTransaction object.
IDBTransaction	transaction(JsArray<java.lang.String> storeNames, java.lang.String mode, IDBTransactionOptions options) An IDBTransaction object.
IDBTransaction	transaction(java.lang.String storeNames) An IDBTransaction object.
IDBTransaction	transaction(java.lang.String[] storeNames) An IDBTransaction object.
IDBTransaction	transaction(java.lang.String[] storeNames, java.lang.String mode) An IDBTransaction object.
IDBTransaction	transaction(java.lang.String[] storeNames, java.lang.String mode, IDBTransactionOptions options) An IDBTransaction object.
IDBTransaction	transaction(java.lang.String storeNames, java.lang.String mode) An IDBTransaction object.
IDBTransaction	transaction(java.lang.String storeNames, java.lang.String mode, IDBTransactionOptions options) An IDBTransaction object.
int	version() An integer containing the version of the connected database.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, is, isExtensible, isFrozen, isSealed, keys, preventExtensions, seal, setPrototypeOf, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

onabort

@Nullable
public EventHandler onabort

The onabort event handler of the IDBDatabase interface handles the abort event, fired when a transaction is aborted and bubbles up to the connection object.

See Also:

IDBDatabase.onabort - MDN, onabort - Indexed Database API 2.0, onabort - Indexed Database API Draft

onclose

@Nullable
public EventHandler onclose

A function which is called when the close event is fired.

See Also:

IDBDatabase.onclose - MDN, onclose - Indexed Database API Draft

onerror

@Nullable
public EventHandler onerror

The onerror event handler of the IDBDatabase interface handles the error event, fired when a request returns an error and bubbles up to the connection object.

See Also:

IDBDatabase.onerror - MDN, onerror - Indexed Database API 2.0, onerror - Indexed Database API Draft

onversionchange

@Nullable
public EventHandler onversionchange

This example shows an IDBOpenDBRequest.onupgradeneeded block that creates a new object store; it also includes onerror and onabort functions to handle non-success cases, and an onversionchange function to notify when a database structure change has occurred.

See Also:

IDBDatabase.onversionchange - MDN, onversionchange - Indexed Database API 2.0, onversionchange - Indexed Database API Draft

Constructor Detail

IDBDatabase

protected IDBDatabase()

Method Detail

name

@JsProperty(name="name")
 @Nonnull
public java.lang.String name()

A DOMString containing the name of the connected database.

See Also:

IDBDatabase.name - MDN, name - Indexed Database API 2.0, name - Indexed Database API Draft

objectStoreNames

@JsProperty(name="objectStoreNames")
 @Nonnull
public DOMStringList objectStoreNames()

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

See Also:

IDBDatabase.objectStoreNames - MDN, objectStoreNames - Indexed Database API 2.0, objectStoreNames - Indexed Database API Draft

version

@JsProperty(name="version")
public int version()

An integer containing the version of the connected database.

See Also:

IDBDatabase.version - MDN, version - Indexed Database API 2.0, version - Indexed Database API Draft

close

public void close()

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.

See Also:

IDBDatabase.close - MDN

createObjectStore

@Nonnull
public IDBObjectStore createObjectStore(@Nonnull
                                                 java.lang.String name,
                                                 @Nonnull
                                                 IDBObjectStoreParameters options)

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.

See Also:

IDBDatabase.createObjectStore - MDN

createObjectStore

@Nonnull
public IDBObjectStore createObjectStore(@Nonnull
                                                 java.lang.String name)

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.

See Also:

IDBDatabase.createObjectStore - MDN

deleteObjectStore

public void deleteObjectStore(@Nonnull
                              java.lang.String name)

As with IDBDatabase.createObjectStore, this method can be called only within a versionchange transaction.

See Also:

IDBDatabase.deleteObjectStore - MDN

transaction

@Nonnull
public IDBTransaction transaction(@Nonnull
                                           java.lang.String storeNames,
                                           @IDBTransactionMode @Nonnull
                                           java.lang.String mode,
                                           @Nonnull
                                           IDBTransactionOptions options)

An IDBTransaction object.

See Also:

IDBDatabase.transaction - MDN

transaction

@Nonnull
public IDBTransaction transaction(@Nonnull
                                           JsArray<java.lang.String> storeNames,
                                           @IDBTransactionMode @Nonnull
                                           java.lang.String mode,
                                           @Nonnull
                                           IDBTransactionOptions options)

An IDBTransaction object.

See Also:

IDBDatabase.transaction - MDN

transaction

@Nonnull
public IDBTransaction transaction(@Nonnull
                                           java.lang.String[] storeNames,
                                           @IDBTransactionMode @Nonnull
                                           java.lang.String mode,
                                           @Nonnull
                                           IDBTransactionOptions options)

An IDBTransaction object.

See Also:

IDBDatabase.transaction - MDN

transaction

@Nonnull
public IDBTransaction transaction(@Nonnull
                                           java.lang.String storeNames,
                                           @IDBTransactionMode @Nonnull
                                           java.lang.String mode)

An IDBTransaction object.

See Also:

IDBDatabase.transaction - MDN

transaction

@Nonnull
public IDBTransaction transaction(@Nonnull
                                           JsArray<java.lang.String> storeNames,
                                           @IDBTransactionMode @Nonnull
                                           java.lang.String mode)

An IDBTransaction object.

See Also:

IDBDatabase.transaction - MDN

transaction

@Nonnull
public IDBTransaction transaction(@Nonnull
                                           java.lang.String[] storeNames,
                                           @IDBTransactionMode @Nonnull
                                           java.lang.String mode)

An IDBTransaction object.

See Also:

IDBDatabase.transaction - MDN

transaction

@Nonnull
public IDBTransaction transaction(@Nonnull
                                           java.lang.String storeNames)

An IDBTransaction object.

See Also:

IDBDatabase.transaction - MDN

transaction

@Nonnull
public IDBTransaction transaction(@Nonnull
                                           JsArray<java.lang.String> storeNames)

An IDBTransaction object.

See Also:

IDBDatabase.transaction - MDN

transaction

@Nonnull
public IDBTransaction transaction(@Nonnull
                                           java.lang.String[] storeNames)

An IDBTransaction object.

See Also:

IDBDatabase.transaction - MDN

addAbortListener

@JsOverlay
public final void addAbortListener(@Nonnull
                                              EventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addAbortListener

@JsOverlay
public final void addAbortListener(@Nonnull
                                              EventListener callback,
                                              boolean useCapture)

addAbortListener

@JsOverlay
public final void addAbortListener(@Nonnull
                                              EventListener callback)

removeAbortListener

@JsOverlay
public final void removeAbortListener(@Nonnull
                                                 EventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeAbortListener

@JsOverlay
public final void removeAbortListener(@Nonnull
                                                 EventListener callback,
                                                 boolean useCapture)

removeAbortListener

@JsOverlay
public final void removeAbortListener(@Nonnull
                                                 EventListener callback)

addCloseListener

@JsOverlay
public final void addCloseListener(@Nonnull
                                              EventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addCloseListener

@JsOverlay
public final void addCloseListener(@Nonnull
                                              EventListener callback,
                                              boolean useCapture)

addCloseListener

@JsOverlay
public final void addCloseListener(@Nonnull
                                              EventListener callback)

removeCloseListener

@JsOverlay
public final void removeCloseListener(@Nonnull
                                                 EventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeCloseListener

@JsOverlay
public final void removeCloseListener(@Nonnull
                                                 EventListener callback,
                                                 boolean useCapture)

removeCloseListener

@JsOverlay
public final void removeCloseListener(@Nonnull
                                                 EventListener callback)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              EventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              EventListener callback,
                                              boolean useCapture)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              EventListener callback)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 EventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 EventListener callback,
                                                 boolean useCapture)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 EventListener callback)

addVersionchangeListener

@JsOverlay
public final void addVersionchangeListener(@Nonnull
                                                      EventListener callback,
                                                      @Nonnull
                                                      AddEventListenerOptions options)

addVersionchangeListener

@JsOverlay
public final void addVersionchangeListener(@Nonnull
                                                      EventListener callback,
                                                      boolean useCapture)

addVersionchangeListener

@JsOverlay
public final void addVersionchangeListener(@Nonnull
                                                      EventListener callback)

removeVersionchangeListener

@JsOverlay
public final void removeVersionchangeListener(@Nonnull
                                                         EventListener callback,
                                                         @Nonnull
                                                         EventListenerOptions options)

removeVersionchangeListener

@JsOverlay
public final void removeVersionchangeListener(@Nonnull
                                                         EventListener callback,
                                                         boolean useCapture)

removeVersionchangeListener

@JsOverlay
public final void removeVersionchangeListener(@Nonnull
                                                         EventListener callback)