akasha.idb

Class IDBIndex

java.lang.Object

akasha.core.JsObject

akasha.idb.IDBIndex

All Implemented Interfaces:

IDBCursorSource, IDBRequestSource

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

IDBIndex interface of the IndexedDB API provides asynchronous access to an index in a database. An index is a kind of object store for looking up records in another object store, called the referenced object store. You use this interface to retrieve data.

See Also:

IDBIndex - MDN, (Indexed DB 3.0) # index-interface

Field Summary

Fields

Modifier and Type	Field and Description
@JsNonNull java.lang.String	name A DOMString specifying a name for the index.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IDBIndex()

Method Summary

Modifier and Type	Method and Description
@JsNonNull IDBRequest	count() A IDBRequest object on which subsequent events related to this operation are fired.
@JsNonNull IDBRequest	count(java.lang.Object query) A IDBRequest object on which subsequent events related to this operation are fired.
@JsNonNull IDBRequest	get(java.lang.Object query) If a value is found, then a structured clone of it is created and set as the result of the request object: this returns the record the key is associated with.
@JsNonNull IDBRequest	getAll() There is a performance cost associated with looking at the value property of a cursor, because the object is created lazily.
@JsNonNull IDBRequest	getAll(java.lang.Object query) There is a performance cost associated with looking at the value property of a cursor, because the object is created lazily.
@JsNonNull IDBRequest	getAll(java.lang.Object query, int count) There is a performance cost associated with looking at the value property of a cursor, because the object is created lazily.
@JsNonNull IDBRequest	getAllKeys() An IDBRequest object on which subsequent events related to this operation are fired.
@JsNonNull IDBRequest	getAllKeys(java.lang.Object query) An IDBRequest object on which subsequent events related to this operation are fired.
@JsNonNull IDBRequest	getAllKeys(java.lang.Object query, int count) An IDBRequest object on which subsequent events related to this operation are fired.
@JsNonNull IDBRequest	getKey(java.lang.Object query) If a primary key is found, it is set as the result of the request object.
jsinterop.base.Any	keyPath() Any data type that can be used as a key path.
boolean	multiEntry() A Boolean:
IDBObjectStore	objectStore() An IDBObjectStore.
@JsNonNull IDBRequest	openCursor() The method sets the position of the cursor to the appropriate record, based on the specified direction.
@JsNonNull IDBRequest	openCursor(java.lang.Object query) The method sets the position of the cursor to the appropriate record, based on the specified direction.
@JsNonNull IDBRequest	openCursor(java.lang.Object query, java.lang.String direction) The method sets the position of the cursor to the appropriate record, based on the specified direction.
@JsNonNull IDBRequest	openKeyCursor() The method sets the position of the cursor to the appropriate key, based on the specified direction.
@JsNonNull IDBRequest	openKeyCursor(java.lang.Object query) The method sets the position of the cursor to the appropriate key, based on the specified direction.
@JsNonNull IDBRequest	openKeyCursor(java.lang.Object query, java.lang.String direction) The method sets the position of the cursor to the appropriate key, based on the specified direction.
boolean	unique() A Boolean:

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 specifying a name for the index.

See Also:

IDBIndex.name - MDN

Constructor Detail

IDBIndex

protected IDBIndex()

Method Detail

keyPath

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

Any data type that can be used as a key path.

See Also:

IDBIndex.keyPath - MDN

multiEntry

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

A Boolean:

See Also:

IDBIndex.multiEntry - MDN

objectStore

@JsProperty(name="objectStore")
 @Nonnull
public IDBObjectStore objectStore()

An IDBObjectStore.

See Also:

IDBIndex.objectStore - MDN

unique

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

A Boolean:

See Also:

IDBIndex.unique - MDN

count

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

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

See Also:

IDBIndex.count - MDN

count

public @JsNonNull IDBRequest count()

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

See Also:

IDBIndex.count - MDN

get

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

If a value is found, then a structured clone of it is created and set as the result of the request object: this returns the record the key is associated with.

See Also:

IDBIndex.get - MDN

getAll

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

There is a performance cost associated with looking at the value property of a cursor, because the object is created lazily. To use a feature like getAll(), the browser has to create all the objects at once. If you are just interested in looking at each of the keys, for instance, it is more efficient to use a cursor. If you are trying to get an array of all the objects in an object store, though, you should use getAll().

See Also:

IDBIndex.getAll - MDN

getAll

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

There is a performance cost associated with looking at the value property of a cursor, because the object is created lazily. To use a feature like getAll(), the browser has to create all the objects at once. If you are just interested in looking at each of the keys, for instance, it is more efficient to use a cursor. If you are trying to get an array of all the objects in an object store, though, you should use getAll().

See Also:

IDBIndex.getAll - MDN

getAll

public @JsNonNull IDBRequest getAll()

There is a performance cost associated with looking at the value property of a cursor, because the object is created lazily. To use a feature like getAll(), the browser has to create all the objects at once. If you are just interested in looking at each of the keys, for instance, it is more efficient to use a cursor. If you are trying to get an array of all the objects in an object store, though, you should use getAll().

See Also:

IDBIndex.getAll - MDN

getAllKeys

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

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

See Also:

IDBIndex.getAllKeys - MDN

getAllKeys

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

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

See Also:

IDBIndex.getAllKeys - MDN

getAllKeys

public @JsNonNull IDBRequest getAllKeys()

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

See Also:

IDBIndex.getAllKeys - MDN

getKey

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

If a primary key is found, it is set as the result of the request object. Note that this doesn't return the whole record as IDBIndex.get does.

See Also:

IDBIndex.getKey - MDN

openCursor

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

The method sets the position of the cursor to the appropriate record, based on the specified direction.

See Also:

IDBIndex.openCursor - MDN

openCursor

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

The method sets the position of the cursor to the appropriate record, based on the specified direction.

See Also:

IDBIndex.openCursor - MDN

openCursor

public @JsNonNull IDBRequest openCursor()

The method sets the position of the cursor to the appropriate record, based on the specified direction.

See Also:

IDBIndex.openCursor - MDN

openKeyCursor

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

The method sets the position of the cursor to the appropriate key, based on the specified direction.

See Also:

IDBIndex.openKeyCursor - MDN

openKeyCursor

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

The method sets the position of the cursor to the appropriate key, based on the specified direction.

See Also:

IDBIndex.openKeyCursor - MDN

openKeyCursor

public @JsNonNull IDBRequest openKeyCursor()

The method sets the position of the cursor to the appropriate key, based on the specified direction.

See Also:

IDBIndex.openKeyCursor - MDN