Class

org.scalajs.dom.raw

IDBIndex

Related Doc: package raw

Permalink

class IDBIndex extends Object

The 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.

You can retrieve records in an object store through their keys or by using an index (cursors provide a third way: see IDBCursor). An index lets you look up records in an object store using properties of the values in the object stores records.

The index is a persistent key-value storage where the value part of its records is the key part of a record in the referenced object store. The records in an index are automatically populated whenever records in the referenced object store are inserted, updated, or deleted. Each record in an index can point to only one record in its referenced object store, but several indexes can reference the same object store. When the object store changes, all indexes that refers to the object store are automatically updated.

MDN

Annotations
@RawJSType() @native()
Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. IDBIndex
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IDBIndex()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def count(): IDBRequest

    Permalink

    If you want to see how many records are between keys 1000 and 2000 in an object store, you can write the following:

    If you want to see how many records are between keys 1000 and 2000 in an object store, you can write the following:

    MDN

  7. def count(key: Any): IDBRequest

    Permalink
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def get(key: Any): IDBRequest

    Permalink

    Returns an IDBRequest object, and, in a separate thread, finds either the value in the referenced object store that corresponds to the given key or the first corresponding value, if key is a key range.

    Returns an IDBRequest object, and, in a separate thread, finds either the value in the referenced object store that corresponds to the given key or the first corresponding value, if key is a key range.

    MDN

  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def getKey(key: Any): IDBRequest

    Permalink

    Returns an IDBRequest object, and, in a separate thread, finds either the given key or the primary key, if key is a key range.

    Returns an IDBRequest object, and, in a separate thread, finds either the given key or the primary key, if key is a key range.

    MDN

  14. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  15. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  18. def keyPath: String

    Permalink

    The key path of this index.

    The key path of this index. If null, this index is not auto-populated.

    MDN

  19. def name: String

    Permalink
  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. def objectStore: IDBObjectStore

    Permalink

    The name of the object store referenced by this index.

    The name of the object store referenced by this index.

    MDN

  24. def openCursor(range: IDBKeyRange = js.native, direction: String = js.native): IDBRequest

    Permalink

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

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

    MDN

  25. def openKeyCursor(range: IDBKeyRange = js.native, direction: String = js.native): IDBRequest

    Permalink

    Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range, as arranged by this index.

    Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range, as arranged by this index.

    MDN

  26. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  29. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  30. def unique: Boolean

    Permalink

    If true, this index does not allow duplicate values for a key.

    If true, this index does not allow duplicate values for a key.

    MDN

  31. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  32. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped