IDBObjectStore

@native @JSGlobal @JSType

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.

class Object
trait Any
class Object
trait Matchable
class Any

Value members

Concrete methods

To determine if the add operation has completed successfully, listen for the transaction’s complete event in addition to the IDBObjectStore.add request’s success event, because the transaction may still fail after the success event fires. In other words, the success event is only triggered when the transaction has been successfully queued.

To determine if the add operation has completed successfully, listen for the transaction’s complete event in addition to the IDBObjectStore.add request’s success event, because the transaction may still fail after the success event fires. In other words, the success event is only triggered when the transaction has been successfully queued.

Returns:

IDBRequest with the key as the target value

Clearing an object store consists of removing all records from the object store and removing all records in indexes that reference the object store.

Clearing an object store consists of removing all records from the object store and removing all records in indexes that reference the object store.

def createIndex(name: String, keyPath: IDBKeyPath, optionalParameters: IDBCreateIndexOptions): IDBIndex

Note that this method must be called only from a VersionChange transaction mode callback.

Note that this method must be called only from a VersionChange transaction mode callback.

Returns an IDBRequest object, and, in a separate thread, deletes the specified record or records.

Returns an IDBRequest object, and, in a separate thread, deletes the specified record or records.

Either a key or an IDBKeyRange can be passed, allowing one or multiple records to be deleted from a store. To delete all records in a store, use clear.

Bear in mind that if you are using an IDBCursor, you can use the IDBCursor.delete method to more efficiently delete the current record — without having to explicitly look up the record's key.

def deleteIndex(indexName: String): Unit

Note that this method must be called only from a VersionChange transaction mode callback. Note that this method synchronously modifies the IDBObjectStore.indexNames property.

Note that this method must be called only from a VersionChange transaction mode callback. Note that this method synchronously modifies the IDBObjectStore.indexNames property.

def index(name: String): IDBIndex

This method may raise a DOMException of one of the following types:

This method may raise a DOMException of one of the following types:

A list of the names of indexes on objects in this object store.

A list of the names of indexes on objects in this object store.

If the record is successfully stored, then a success event is fired on the returned request object with the result set to the key for the stored record, and the transaction set to the transaction in which this object store is opened.

If the record is successfully stored, then a success event is fired on the returned request object with the result set to the key for the stored record, and the transaction set to the transaction in which this object store is opened.

Returns:

IDBRequest with the key as the target value

The name of the transaction to which this object store belongs.

The name of the transaction to which this object store belongs.

Inherited methods

Inherited from:
IDBStoreLike

Returns an IDBRequest object, and, in a separate thread, returns the object store selected by the specified key. This is for retrieving specific records from an object store.

Returns an IDBRequest object, and, in a separate thread, returns the object store selected by the specified key. This is for retrieving specific records from an object store.

Note: This method produces the same result for: a) a record that doesn't exist in the database and b) a record that has an undefined value. To tell these situations apart, call the openCursor method with the same key. That method provides a cursor if the record exists, and no cursor if it does not.

Inherited from:
IDBStoreLike
def getAll(query: UndefOr[IDBKeyRange | IDBKey], count: UndefOr[Double]): IDBRequest[IDBObjectStore, Array[IDBValue]]

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.

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.

If a value is successfully found, then a structured clone of it is created and set as the result of the request object.

This method produces the same result for:

  • a record that doesn't exist in the database
  • a record that has an undefined value

To tell these situations apart, you either call

  • the openCursor method with the same key. That method provides a cursor if the record exists, and no cursor if it does not.
  • the count method with the same key, which will return 1 if the row exists and 0 if it doesn't.
Inherited from:
IDBStoreLike
def getAllKeys(query: UndefOr[IDBKeyRange | IDBKey], count: UndefOr[Double]): IDBRequest[IDBObjectStore, Array[IDBKey]]

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.

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.

If a value is successfully found, then a structured clone of it is created and set as the result of the request object.

This method produces the same result for:

  • a record that doesn't exist in the database
  • a record that has an undefined value

To tell these situations apart, you need to call the openCursor method with the same key. That method provides a cursor if the record exists, and no cursor if it does not.

Inherited from:
IDBStoreLike

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.

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.

Inherited from:
IDBStoreLike
def hasOwnProperty(v: String): Boolean
Inherited from:
Object
def isPrototypeOf(v: Object): Boolean
Inherited from:
Object

The key path of this object store. If this attribute is null, the application must provide a key for each modification operation.

The key path of this object store. If this attribute is null, the application must provide a key for each modification operation.

Inherited from:
IDBStoreLike
def name: String
Inherited from:
IDBStoreLike

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.

Returns:

IDBRequest with the target value being a new cursor or null.

Inherited from:
IDBStoreLike

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

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

Returns:

IDBRequest with the target value being a new cursor or null.

Inherited from:
IDBStoreLike
def propertyIsEnumerable(v: String): Boolean
Inherited from:
Object
def toLocaleString(): String
Inherited from:
Object
def valueOf(): Any
Inherited from:
Object