akasha.idb

Class IDBObjectStore

java.lang.Object

akasha.core.JsObject

akasha.idb.IDBObjectStore

All Implemented Interfaces:

IDBCursorSource, IDBRequestSource

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="IDBObjectStore")
public class IDBObjectStore
extends JsObject
implements IDBRequestSource, IDBCursorSource

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.

See Also:

IDBObjectStore - MDN, # object-store-interface

Field Summary

Fields

Modifier and Type	Field and Description
@JsNonNull java.lang.String	name A DOMString containing the object store's name.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IDBObjectStore()

Method Summary

Modifier and Type	Method and Description
@JsNonNull IDBRequest	add(java.lang.Object value) To determine if the add operation has completed successfully, listen for the transaction’s complete event in addition to the IDBObjectStore.add request’s success event, because the transaction may still fail after the success event fires.
@JsNonNull IDBRequest	add(java.lang.Object value, java.lang.Object key) To determine if the add operation has completed successfully, listen for the transaction’s complete event in addition to the IDBObjectStore.add request’s success event, because the transaction may still fail after the success event fires.
boolean	autoIncrement() A Boolean:
@JsNonNull IDBRequest	clear() Clearing an object store consists of removing all records from the object store and removing all records in indexes that reference the object store.
@JsNonNull IDBRequest	count() An IDBRequest object on which subsequent events related to this operation are fired.
@JsNonNull IDBRequest	count(java.lang.Object query) An IDBRequest object on which subsequent events related to this operation are fired.
@JsNonNull IDBIndex	createIndex(java.lang.String name, JsArray<java.lang.String> keyPath) Note that this method must be called only from a VersionChange transaction mode callback.
@JsNonNull IDBIndex	createIndex(java.lang.String name, JsArray<java.lang.String> keyPath, IDBIndexParameters options) Note that this method must be called only from a VersionChange transaction mode callback.
@JsNonNull IDBIndex	createIndex(java.lang.String name, java.lang.String... keyPath) Note that this method must be called only from a VersionChange transaction mode callback.
@JsNonNull IDBIndex	createIndex(java.lang.String name, java.lang.String keyPath) Note that this method must be called only from a VersionChange transaction mode callback.
@JsNonNull IDBIndex	createIndex(java.lang.String name, java.lang.String[] keyPath, IDBIndexParameters options) Note that this method must be called only from a VersionChange transaction mode callback.
@JsNonNull IDBIndex	createIndex(java.lang.String name, java.lang.String keyPath, IDBIndexParameters options) Note that this method must be called only from a VersionChange transaction mode callback.
@JsNonNull IDBRequest	delete(java.lang.Object query) An IDBRequest object on which subsequent events related to this operation are fired.
void	deleteIndex(java.lang.String name) Note that this method must be called only from a VersionChange transaction mode callback.
@JsNonNull IDBRequest	get(java.lang.Object query) If a value is successfully found, then a structured clone of it is created and set as the result of the request object.
@JsNonNull IDBRequest	getAll() If a value is successfully found, then a structured clone of it is created and set as the result of the request object.
@JsNonNull IDBRequest	getAll(java.lang.Object query) If a value is successfully found, then a structured clone of it is created and set as the result of the request object.
@JsNonNull IDBRequest	getAll(java.lang.Object query, int count) If a value is successfully found, then a structured clone of it is created and set as the result of the request object.
@JsNonNull IDBRequest	getAllKeys() If a value is successfully found, then a structured clone of it is created and set as the result of the request object.
@JsNonNull IDBRequest	getAllKeys(java.lang.Object query) If a value is successfully found, then a structured clone of it is created and set as the result of the request object.
@JsNonNull IDBRequest	getAllKeys(java.lang.Object query, int count) If a value is successfully found, then a structured clone of it is created and set as the result of the request object.
@JsNonNull IDBRequest	getKey(java.lang.Object query) If a key is successfully found, then a structured clone of it is created and set as the result of the request object.
@JsNonNull IDBIndex	index(java.lang.String name) An IDBIndex object for accessing the index.
DOMStringList	indexNames() A DOMStringList.
jsinterop.base.Any	keyPath() If this property is null, the application must provide a key for each modification operation.
@JsNonNull IDBRequest	openCursor() To determine if the add operation has completed successfully, listen for the results’s success event.
@JsNonNull IDBRequest	openCursor(java.lang.Object query) To determine if the add operation has completed successfully, listen for the results’s success event.
@JsNonNull IDBRequest	openCursor(java.lang.Object query, java.lang.String direction) To determine if the add operation has completed successfully, listen for the results’s success event.
@JsNonNull IDBRequest	openKeyCursor() To determine if the add operation has completed successfully, listen for the results’s success event.
@JsNonNull IDBRequest	openKeyCursor(java.lang.Object query) To determine if the add operation has completed successfully, listen for the results’s success event.
@JsNonNull IDBRequest	openKeyCursor(java.lang.Object query, java.lang.String direction) To determine if the add operation has completed successfully, listen for the results’s success event.
@JsNonNull IDBRequest	put(java.lang.Object value) The put method is an update or insert method.
@JsNonNull IDBRequest	put(java.lang.Object value, java.lang.Object key) The put method is an update or insert method.
IDBTransaction	transaction() An IDBTransaction object.

Methods inherited from class akasha.core.JsObject

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

Methods inherited from class java.lang.Object

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

Field Detail

name

public @JsNonNull java.lang.String name

A DOMString containing the object store's name.

See Also:

IDBObjectStore.name - MDN

Constructor Detail

IDBObjectStore

protected IDBObjectStore()

Method Detail

autoIncrement

@JsProperty(name="autoIncrement")
public boolean autoIncrement()

A Boolean:

See Also:

IDBObjectStore.autoIncrement - MDN

indexNames

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

A DOMStringList.

See Also:

IDBObjectStore.indexNames - MDN

keyPath

@JsProperty(name="keyPath")
 @Nullable
public jsinterop.base.Any keyPath()

If this property is null, the application must provide a key for each modification operation.

See Also:

IDBObjectStore.keyPath - MDN

transaction

@JsProperty(name="transaction")
 @Nonnull
public IDBTransaction transaction()

An IDBTransaction object.

See Also:

IDBObjectStore.transaction - MDN

add

public @JsNonNull IDBRequest add(@Nullable
                                 java.lang.Object value,
                                 @Nullable
                                 java.lang.Object key)

To determine if the add operation has completed successfully, listen for the transaction’s complete event in addition to the IDBObjectStore.add request’s success event, because the transaction may still fail after the success event fires. In other words, the success event is only triggered when the transaction has been successfully queued.

See Also:

IDBObjectStore.add - MDN

add

public @JsNonNull IDBRequest add(@Nullable
                                 java.lang.Object value)

To determine if the add operation has completed successfully, listen for the transaction’s complete event in addition to the IDBObjectStore.add request’s success event, because the transaction may still fail after the success event fires. In other words, the success event is only triggered when the transaction has been successfully queued.

See Also:

IDBObjectStore.add - MDN

clear

public @JsNonNull IDBRequest clear()

Clearing an object store consists of removing all records from the object store and removing all records in indexes that reference the object store. To remove only some of the records in a store, use IDBObjectStore.delete passing a key or IDBKeyRange.

See Also:

IDBObjectStore.clear - MDN

count

public @JsNonNull IDBRequest count(@Nullable
                                   java.lang.Object query)

An IDBRequest object on which subsequent events related to this operation are fired.

See Also:

IDBObjectStore.count - MDN

count

public @JsNonNull IDBRequest count()

An IDBRequest object on which subsequent events related to this operation are fired.

See Also:

IDBObjectStore.count - MDN

createIndex

public @JsNonNull IDBIndex createIndex(@Nonnull
                                       java.lang.String name,
                                       @Nonnull
                                       java.lang.String keyPath,
                                       @Nonnull
                                       IDBIndexParameters options)

Note that this method must be called only from a VersionChange transaction mode callback.

See Also:

IDBObjectStore.createIndex - MDN, createIndex() - Indexed Database API 2.0, createIndex() - Indexed Database API Draft

createIndex

public @JsNonNull IDBIndex createIndex(@Nonnull
                                       java.lang.String name,
                                       @Nonnull
                                       JsArray<java.lang.String> keyPath,
                                       @Nonnull
                                       IDBIndexParameters options)

Note that this method must be called only from a VersionChange transaction mode callback.

See Also:

IDBObjectStore.createIndex - MDN, createIndex() - Indexed Database API 2.0, createIndex() - Indexed Database API Draft

createIndex

public @JsNonNull IDBIndex createIndex(@Nonnull
                                       java.lang.String name,
                                       @Nonnull
                                       java.lang.String[] keyPath,
                                       @Nonnull
                                       IDBIndexParameters options)

Note that this method must be called only from a VersionChange transaction mode callback.

See Also:

IDBObjectStore.createIndex - MDN, createIndex() - Indexed Database API 2.0, createIndex() - Indexed Database API Draft

createIndex

public @JsNonNull IDBIndex createIndex(@Nonnull
                                       java.lang.String name,
                                       @Nonnull
                                       java.lang.String keyPath)

Note that this method must be called only from a VersionChange transaction mode callback.

See Also:

IDBObjectStore.createIndex - MDN, createIndex() - Indexed Database API 2.0, createIndex() - Indexed Database API Draft

createIndex

public @JsNonNull IDBIndex createIndex(@Nonnull
                                       java.lang.String name,
                                       @Nonnull
                                       JsArray<java.lang.String> keyPath)

Note that this method must be called only from a VersionChange transaction mode callback.

See Also:

IDBObjectStore.createIndex - MDN, createIndex() - Indexed Database API 2.0, createIndex() - Indexed Database API Draft

createIndex

@JsOverlay
public final @JsNonNull IDBIndex createIndex(@Nonnull
                                                        java.lang.String name,
                                                        @Nonnull
                                                        java.lang.String... keyPath)

Note that this method must be called only from a VersionChange transaction mode callback.

See Also:

IDBObjectStore.createIndex - MDN, createIndex() - Indexed Database API 2.0, createIndex() - Indexed Database API Draft

delete

public @JsNonNull IDBRequest delete(@Nullable
                                    java.lang.Object query)

An IDBRequest object on which subsequent events related to this operation are fired. The request.result attribute is set to undefined.

See Also:

IDBObjectStore.delete - MDN

deleteIndex

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

Note that this method must be called only from a VersionChange transaction mode callback. Note that this method synchronously modifies the IDBObjectStore.indexNames property.

See Also:

IDBObjectStore.deleteIndex - MDN, deleteIndex() - Indexed Database API 2.0, deleteIndex() - Indexed Database API Draft

get

public @JsNonNull IDBRequest get(@Nullable
                                 java.lang.Object query)

If a value is successfully found, then a structured clone of it is created and set as the result of the request object.

See Also:

IDBObjectStore.get - MDN, get() - Indexed Database API 2.0, get() - Indexed Database API Draft

getAll

public @JsNonNull IDBRequest getAll(@Nullable
                                    java.lang.Object query,
                                    int count)

If a value is successfully found, then a structured clone of it is created and set as the result of the request object.

See Also:

IDBObjectStore.getAll - MDN, getAll() - Indexed Database API Draft

getAll

public @JsNonNull IDBRequest getAll(@Nullable
                                    java.lang.Object query)

If a value is successfully found, then a structured clone of it is created and set as the result of the request object.

See Also:

IDBObjectStore.getAll - MDN, getAll() - Indexed Database API Draft

getAll

public @JsNonNull IDBRequest getAll()

If a value is successfully found, then a structured clone of it is created and set as the result of the request object.

See Also:

IDBObjectStore.getAll - MDN, getAll() - Indexed Database API Draft

getAllKeys

public @JsNonNull IDBRequest getAllKeys(@Nullable
                                        java.lang.Object query,
                                        int count)

If a value is successfully found, then a structured clone of it is created and set as the result of the request object.

See Also:

IDBObjectStore.getAllKeys - MDN, getAllKeys() - Indexed Database API Draft

getAllKeys

public @JsNonNull IDBRequest getAllKeys(@Nullable
                                        java.lang.Object query)

If a value is successfully found, then a structured clone of it is created and set as the result of the request object.

See Also:

IDBObjectStore.getAllKeys - MDN, getAllKeys() - Indexed Database API Draft

getAllKeys

public @JsNonNull IDBRequest getAllKeys()

If a value is successfully found, then a structured clone of it is created and set as the result of the request object.

See Also:

IDBObjectStore.getAllKeys - MDN, getAllKeys() - Indexed Database API Draft

getKey

public @JsNonNull IDBRequest getKey(@Nullable
                                    java.lang.Object query)

If a key is successfully found, then a structured clone of it is created and set as the result of the request object.

See Also:

IDBObjectStore.getKey - MDN, getKey() - Indexed Database API Draft

index

public @JsNonNull IDBIndex index(@Nonnull
                                 java.lang.String name)

An IDBIndex object for accessing the index.

See Also:

IDBObjectStore.index - MDN

openCursor

public @JsNonNull IDBRequest openCursor(@Nullable
                                        java.lang.Object query,
                                        @IDBCursorDirection @Nonnull
                                        java.lang.String direction)

To determine if the add operation has completed successfully, listen for the results’s success event.

See Also:

IDBObjectStore.openCursor - MDN

openCursor

public @JsNonNull IDBRequest openCursor(@Nullable
                                        java.lang.Object query)

To determine if the add operation has completed successfully, listen for the results’s success event.

See Also:

IDBObjectStore.openCursor - MDN

openCursor

public @JsNonNull IDBRequest openCursor()

To determine if the add operation has completed successfully, listen for the results’s success event.

See Also:

IDBObjectStore.openCursor - MDN

openKeyCursor

public @JsNonNull IDBRequest openKeyCursor(@Nullable
                                           java.lang.Object query,
                                           @IDBCursorDirection @Nonnull
                                           java.lang.String direction)

To determine if the add operation has completed successfully, listen for the results’s success event.

See Also:

IDBObjectStore.openKeyCursor - MDN, openKeyCursor() - Indexed Database API 2.0, openKeyCursor() - Indexed Database API Draft

openKeyCursor

public @JsNonNull IDBRequest openKeyCursor(@Nullable
                                           java.lang.Object query)

To determine if the add operation has completed successfully, listen for the results’s success event.

See Also:

IDBObjectStore.openKeyCursor - MDN, openKeyCursor() - Indexed Database API 2.0, openKeyCursor() - Indexed Database API Draft

openKeyCursor

public @JsNonNull IDBRequest openKeyCursor()

To determine if the add operation has completed successfully, listen for the results’s success event.

See Also:

IDBObjectStore.openKeyCursor - MDN, openKeyCursor() - Indexed Database API 2.0, openKeyCursor() - Indexed Database API Draft

put

public @JsNonNull IDBRequest put(@Nullable
                                 java.lang.Object value,
                                 @Nullable
                                 java.lang.Object key)

The put method is an update or insert method. See the IDBObjectStore.add method for an insert only method.

See Also:

IDBObjectStore.put - MDN

put

public @JsNonNull IDBRequest put(@Nullable
                                 java.lang.Object value)

The put method is an update or insert method. See the IDBObjectStore.add method for an insert only method.

See Also:

IDBObjectStore.put - MDN