IDBObjectStore extension type

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.

on
Implemented types

Properties

autoIncrement → bool
no setter
hashCode → int
The hash code for this object.
no setterinherited
indexNames → DOMStringList
no setter
keyPath → JSAny?
no setter
name ↔ String
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transaction → IDBTransaction
no setter

Methods

add(JSAny? value, [JSAny? key]) → IDBRequest
The add() method of the IDBObjectStore interface returns an IDBRequest object, and, in a separate thread, creates a structured clone of the value, and stores the cloned value in the object store. This is for adding new records to an object store.
clear() → IDBRequest
The clear() method of the IDBObjectStore interface creates and immediately returns an IDBRequest object, and clears this object store in a separate thread. This is for deleting all the current data out of an object store.
count([JSAny? query]) → IDBRequest
The count() method of the IDBObjectStore interface returns an IDBRequest object, and, in a separate thread, returns the total number of records that match the provided key or IDBKeyRange. If no arguments are provided, it returns the total number of records in the store.
createIndex(String name, JSAny keyPath, [IDBIndexParameters options]) → IDBIndex
The createIndex() method of the IDBObjectStore interface creates and returns a new IDBIndex object in the connected database. It creates a new field/column defining a new data point for each database record to contain.
delete(JSAny? query) → IDBRequest
The delete() method of the IDBObjectStore interface returns an IDBRequest object, and, in a separate thread, deletes the specified record or records.
deleteIndex(String name) → void
The deleteIndex() method of the IDBObjectStore interface destroys the index with the specified name in the connected database, used during a version upgrade.
get(JSAny? query) → IDBRequest
The get() method of the IDBObjectStore interface returns an IDBRequest object, and, in a separate thread, returns the object selected by the specified key. This is for retrieving specific records from an object store.
getAll([JSAny? query, int count]) → IDBRequest
The getAll() method of the IDBObjectStore interface returns an IDBRequest object containing all objects in the object store matching the specified parameter or all objects in the store if no parameters are given.
getAllKeys([JSAny? query, int count]) → IDBRequest
The getAllKeys() method of the IDBObjectStore interface returns an IDBRequest object retrieves record keys for all objects in the object store matching the specified parameter or all objects in the store if no parameters are given.
getKey(JSAny? query) → IDBRequest
The getKey() method of the IDBObjectStore interface returns an IDBRequest object, and, in a separate thread, returns the key selected by the specified query. This is for retrieving specific records from an object store.
index(String name) → IDBIndex
The index() method of the IDBObjectStore interface opens a named index in the current object store, after which it can be used to, for example, return a series of records sorted by that index using a cursor.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
openCursor([JSAny? query, IDBCursorDirection direction]) → IDBRequest
The openCursor() method of the IDBObjectStore interface returns an IDBRequest object, and, in a separate thread, returns a new IDBCursorWithValue object. Used for iterating through an object store with a cursor.
openKeyCursor([JSAny? query, IDBCursorDirection direction]) → IDBRequest
The openKeyCursor() method of the IDBObjectStore interface returns an IDBRequest object whose result will be set to an IDBCursor that can be used to iterate through matching results. Used for iterating through the keys of an object store with a cursor.
put(JSAny? value, [JSAny? key]) → IDBRequest
The put() method of the IDBObjectStore interface updates a given record in a database, or inserts a new record if the given item does not already exist.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited