class IDBObjectStore extends Object with IDBStoreLike[IDBObjectStore]
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.
- Annotations
- @JSType() @native() @JSGlobal()
- Alphabetic
- By Inheritance
- IDBObjectStore
- IDBStoreLike
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new IDBObjectStore()
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def add(value: IDBValue, key: IDBKey = js.native): IDBRequest[IDBObjectStore, IDBKey]
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.
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
targetvalue
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clear(): IDBRequest[IDBObjectStore, Unit]
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 clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def count(query: |[IDBKey, IDBKeyRange] = js.native): IDBRequest[IDBObjectStore, Double]
- Definition Classes
- IDBStoreLike
- def createIndex(name: String, keyPath: IDBKeyPath, optionalParameters: IDBCreateIndexOptions = js.native): IDBIndex
Note that this method must be called only from a VersionChange transaction mode callback.
- def delete(key: |[IDBKey, IDBKeyRange]): IDBRequest[IDBObjectStore, Unit]
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 must be called only from a VersionChange transaction mode callback. Note that this method synchronously modifies the IDBObjectStore.indexNames property.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def get(key: |[IDBKey, IDBKeyRange]): IDBRequest[IDBObjectStore, IDBValue]
Returns an IDBRequest object, and, in a separate thread, returns the object store selected by the specified key.
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.
- Definition Classes
- IDBStoreLike
- def getAll(query: UndefOr[|[IDBKeyRange, IDBKey]] = js.native, count: UndefOr[Double] = js.native): 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.
- Definition Classes
- IDBStoreLike
- def getAllKeys(query: UndefOr[|[IDBKeyRange, IDBKey]] = js.native, count: UndefOr[Double] = js.native): 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.
- Definition Classes
- IDBStoreLike
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getKey(key: IDBKey): IDBRequest[IDBObjectStore, UndefOr[IDBKey]]
Returns an IDBRequest object, and, in a separate thread, returns the key selected by the specified query.
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.
- Definition Classes
- IDBStoreLike
- def hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def index(name: String): IDBIndex
This method may raise a DOMException of one of the following types:
- def indexNames: DOMStringList
A list of the names of indexes on objects in this object store.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
- def keyPath: IDBKeyPath
The key path of this object store.
The key path of this object store. If this attribute is null, the application must provide a key for each modification operation.
- Definition Classes
- IDBStoreLike
- def name: String
- Definition Classes
- IDBStoreLike
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def openCursor(range: UndefOr[|[IDBKeyRange, IDBKey]] = js.native, direction: UndefOr[IDBCursorDirection] = js.native): IDBRequest[IDBObjectStore, IDBCursorWithValue[IDBObjectStore]]
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
targetvalue being a new cursor ornull.
- Definition Classes
- IDBStoreLike
- def openKeyCursor(range: UndefOr[|[IDBKeyRange, IDBKey]] = js.native, direction: UndefOr[IDBCursorDirection] = js.native): IDBRequest[IDBObjectStore, IDBCursor[IDBObjectStore]]
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
targetvalue being a new cursor ornull.
- Definition Classes
- IDBStoreLike
- def propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
- def put(value: IDBValue, key: IDBKey = js.native): IDBRequest[IDBObjectStore, IDBKey]
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
targetvalue
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toLocaleString(): String
- Definition Classes
- Object
- def toString(): String
- Definition Classes
- AnyRef → Any
- def transaction: IDBTransaction
The name of the transaction to which this object store belongs.
- def valueOf(): Any
- Definition Classes
- Object
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()