IDBIndex

Overview

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.

Location

 

count

Returns an IDBRequest object, and in a separate thread, returns the number of records within a key range.

 

method count(parkey: dynamic): IDBRequest

 

IDBRequest count(dynamic parkey)

 

func count(_ parkey: dynamic) -> IDBRequest

 

IDBRequest count(dynamic parkey)

 

Function count(parkey As dynamic) As IDBRequest

Parameters:

  • parkey:

get

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 an IDBKeyRange.

 

method get(parkey: dynamic): IDBRequest

 

IDBRequest get(dynamic parkey)

 

func get(_ parkey: dynamic) -> IDBRequest

 

IDBRequest get(dynamic parkey)

 

Function get(parkey As dynamic) As IDBRequest

Parameters:

  • parkey:

getAll

Returns an IDBRequest object, in a separate thread, finds all matching values in the referenced object store that correspond to the given key or are in range, if key is an IDBKeyRange.

 

method getAll(parquery: dynamic; parcount: dynamic): IDBRequest

 

IDBRequest getAll(dynamic parquery, dynamic parcount)

 

func getAll(_ parquery: dynamic, _ parcount: dynamic) -> IDBRequest

 

IDBRequest getAll(dynamic parquery, dynamic parcount)

 

Function getAll(parquery As dynamic, parcount As dynamic) As IDBRequest

Parameters:

  • parquery:
  • parcount:

getAllKeys

Returns an IDBRequest object, in a separate thread, finds all matching keys in the referenced object store that correspond to the given key or are in range, if key is an IDBKeyRange.

 

method getAllKeys(parquery: dynamic; parcount: dynamic): IDBRequest

 

IDBRequest getAllKeys(dynamic parquery, dynamic parcount)

 

func getAllKeys(_ parquery: dynamic, _ parcount: dynamic) -> IDBRequest

 

IDBRequest getAllKeys(dynamic parquery, dynamic parcount)

 

Function getAllKeys(parquery As dynamic, parcount As dynamic) As IDBRequest

Parameters:

  • parquery:
  • parcount:

getKey

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

 

method getKey(parkey: dynamic): IDBRequest

 

IDBRequest getKey(dynamic parkey)

 

func getKey(_ parkey: dynamic) -> IDBRequest

 

IDBRequest getKey(dynamic parkey)

 

Function getKey(parkey As dynamic) As IDBRequest

Parameters:

  • parkey:

keyPath

 

property keyPath: dynamic read;

 

dynamic keyPath { get; }

 

var keyPath: dynamic { get{} }

 

dynamic keyPath { __get; }

 

ReadOnly Property keyPath() As dynamic

multiEntry

 

property multiEntry: Boolean read;

 

Boolean multiEntry { get; }

 

var multiEntry: Boolean { get{} }

 

Boolean multiEntry { __get; }

 

ReadOnly Property multiEntry() As Boolean

name

 

property name: String read write;

 

String name { get; set; }

 

var name: String { get{} set{} }

 

String name { __get; __set; }

 

Property name() As String

objectStore

 

property objectStore: String read;

 

String objectStore { get; }

 

var objectStore: String { get{} }

 

String objectStore { __get; }

 

ReadOnly Property objectStore() As String

openCursor

Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range.

 

method openCursor(parrange: dynamic; pardirection: dynamic): IDBRequest

 

IDBRequest openCursor(dynamic parrange, dynamic pardirection)

 

func openCursor(_ parrange: dynamic, _ pardirection: dynamic) -> IDBRequest

 

IDBRequest openCursor(dynamic parrange, dynamic pardirection)

 

Function openCursor(parrange As dynamic, pardirection As dynamic) As IDBRequest

Parameters:

  • parrange:
  • pardirection:

openKeyCursor

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

 

method openKeyCursor(parrange: dynamic; pardirection: dynamic): IDBRequest

 

IDBRequest openKeyCursor(dynamic parrange, dynamic pardirection)

 

func openKeyCursor(_ parrange: dynamic, _ pardirection: dynamic) -> IDBRequest

 

IDBRequest openKeyCursor(dynamic parrange, dynamic pardirection)

 

Function openKeyCursor(parrange As dynamic, pardirection As dynamic) As IDBRequest

Parameters:

  • parrange:
  • pardirection:

unique

 

property unique: Boolean read;

 

Boolean unique { get; }

 

var unique: Boolean { get{} }

 

Boolean unique { __get; }

 

ReadOnly Property unique() As Boolean

 

keyPath

 

property keyPath: dynamic read;

 

dynamic keyPath { get; }

 

var keyPath: dynamic { get{} }

 

dynamic keyPath { __get; }

 

ReadOnly Property keyPath() As dynamic

multiEntry

 

property multiEntry: Boolean read;

 

Boolean multiEntry { get; }

 

var multiEntry: Boolean { get{} }

 

Boolean multiEntry { __get; }

 

ReadOnly Property multiEntry() As Boolean

name

 

property name: String read write;

 

String name { get; set; }

 

var name: String { get{} set{} }

 

String name { __get; __set; }

 

Property name() As String

objectStore

 

property objectStore: String read;

 

String objectStore { get; }

 

var objectStore: String { get{} }

 

String objectStore { __get; }

 

ReadOnly Property objectStore() As String

unique

 

property unique: Boolean read;

 

Boolean unique { get; }

 

var unique: Boolean { get{} }

 

Boolean unique { __get; }

 

ReadOnly Property unique() As Boolean

 

count

Returns an IDBRequest object, and in a separate thread, returns the number of records within a key range.

 

method count(parkey: dynamic): IDBRequest

 

IDBRequest count(dynamic parkey)

 

func count(_ parkey: dynamic) -> IDBRequest

 

IDBRequest count(dynamic parkey)

 

Function count(parkey As dynamic) As IDBRequest

Parameters:

  • parkey:

get

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 an IDBKeyRange.

 

method get(parkey: dynamic): IDBRequest

 

IDBRequest get(dynamic parkey)

 

func get(_ parkey: dynamic) -> IDBRequest

 

IDBRequest get(dynamic parkey)

 

Function get(parkey As dynamic) As IDBRequest

Parameters:

  • parkey:

getAll

Returns an IDBRequest object, in a separate thread, finds all matching values in the referenced object store that correspond to the given key or are in range, if key is an IDBKeyRange.

 

method getAll(parquery: dynamic; parcount: dynamic): IDBRequest

 

IDBRequest getAll(dynamic parquery, dynamic parcount)

 

func getAll(_ parquery: dynamic, _ parcount: dynamic) -> IDBRequest

 

IDBRequest getAll(dynamic parquery, dynamic parcount)

 

Function getAll(parquery As dynamic, parcount As dynamic) As IDBRequest

Parameters:

  • parquery:
  • parcount:

getAllKeys

Returns an IDBRequest object, in a separate thread, finds all matching keys in the referenced object store that correspond to the given key or are in range, if key is an IDBKeyRange.

 

method getAllKeys(parquery: dynamic; parcount: dynamic): IDBRequest

 

IDBRequest getAllKeys(dynamic parquery, dynamic parcount)

 

func getAllKeys(_ parquery: dynamic, _ parcount: dynamic) -> IDBRequest

 

IDBRequest getAllKeys(dynamic parquery, dynamic parcount)

 

Function getAllKeys(parquery As dynamic, parcount As dynamic) As IDBRequest

Parameters:

  • parquery:
  • parcount:

getKey

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

 

method getKey(parkey: dynamic): IDBRequest

 

IDBRequest getKey(dynamic parkey)

 

func getKey(_ parkey: dynamic) -> IDBRequest

 

IDBRequest getKey(dynamic parkey)

 

Function getKey(parkey As dynamic) As IDBRequest

Parameters:

  • parkey:

openCursor

Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range.

 

method openCursor(parrange: dynamic; pardirection: dynamic): IDBRequest

 

IDBRequest openCursor(dynamic parrange, dynamic pardirection)

 

func openCursor(_ parrange: dynamic, _ pardirection: dynamic) -> IDBRequest

 

IDBRequest openCursor(dynamic parrange, dynamic pardirection)

 

Function openCursor(parrange As dynamic, pardirection As dynamic) As IDBRequest

Parameters:

  • parrange:
  • pardirection:

openKeyCursor

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

 

method openKeyCursor(parrange: dynamic; pardirection: dynamic): IDBRequest

 

IDBRequest openKeyCursor(dynamic parrange, dynamic pardirection)

 

func openKeyCursor(_ parrange: dynamic, _ pardirection: dynamic) -> IDBRequest

 

IDBRequest openKeyCursor(dynamic parrange, dynamic pardirection)

 

Function openKeyCursor(parrange As dynamic, pardirection As dynamic) As IDBRequest

Parameters:

  • parrange:
  • pardirection: