IDBIndex class
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 the primary key or by using an index. An index lets you look up records in an object store using properties of the values in the object stores records other than the primary key 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. You can grab a set of keys within a range. To learn more, see IDBKeyRange. Note: This feature is available in Web Workers
- Available extensions
- Annotations
-
- @JS()
- @staticInterop
Constructors
- IDBIndex()
-
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- keyPath → dynamic
-
Available on IDBIndex, provided by the PropsIDBIndex extension
no setter - multiEntry → bool
-
Available on IDBIndex, provided by the PropsIDBIndex extension
no setter - name ↔ String
-
Available on IDBIndex, provided by the PropsIDBIndex extension
getter/setter pair - objectStore → IDBObjectStore
-
Available on IDBIndex, provided by the PropsIDBIndex extension
no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- unique → bool
-
Available on IDBIndex, provided by the PropsIDBIndex extension
no setter
Methods
-
count(
[dynamic query]) → IDBRequest -
Available on IDBIndex, provided by the PropsIDBIndex extension
-
get(
dynamic query) → IDBRequest -
Available on IDBIndex, provided by the PropsIDBIndex extension
-
getAll(
[dynamic query, int? count]) → IDBRequest -
Available on IDBIndex, provided by the PropsIDBIndex extension
-
getAllKeys(
[dynamic query, int? count]) → IDBRequest -
Available on IDBIndex, provided by the PropsIDBIndex extension
-
getKey(
dynamic query) → IDBRequest -
Available on IDBIndex, provided by the PropsIDBIndex extension
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
openCursor(
[dynamic query, IDBCursorDirection? direction = IDBCursorDirection.next]) → IDBRequest -
Available on IDBIndex, provided by the PropsIDBIndex extension
-
openKeyCursor(
[dynamic query, IDBCursorDirection? direction = IDBCursorDirection.next]) → IDBRequest -
Available on IDBIndex, provided by the PropsIDBIndex extension
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited