The 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.
Inherits from: EventTarget
Returns an IDBRequest object, and in a separate thread, returns the number of records within a key range. For example, if you want to see how many records are between keys 1000 and 2000 in an object store, you can write the following: var req = store.count(IDBKeyRange.bound(1000, 2000));
IDBRequest count ( in optional any key ) raises (IDBDatabaseException);
This method can raise a IDBDatabaseException with the following code:
Attribute | Description |
---|---|
DATA_ERR | The key parameter was not a valid value. |
NOT_ALLOWED_ERR | The request was made on a source object that has been deleted or removed. |
Returns an IDBRequest object, and, in a separate thread, finds either:
key
is a key range.If a value is successfully found, then a structured clone of it is created and set as the result
of the request object.
IDBRequest get ( in any key ) raises (IDBDatabaseException);
This method can raise an IDBDatabaseException with the following code:
Attribute | Description |
---|---|
TRANSACTION_INACTIVE_ERR | The index's transaction is not active. |
DATA_ERR | The key parameter was not a valid value. |
NOT_ALLOWED_ERR | The request was made on a source object that has been deleted or removed. |
Returns an IDBRequest object, and, in a separate thread, finds either:
key
is a key range.If a value is successfully found, then a structured clone of it is created and set as the result
of the request object.
IDBRequest getKey ( in any key ) raises (IDBDatabaseException);
This method can raise a IDBDatabaseException with the following code:
Attribute | Description |
---|---|
TRANSACTION_INACTIVE_ERR | The index's transaction is not active. |
DATA_ERR | The key parameter was not a valid value. |
NOT_ALLOWED_ERR | The request was made on a source object that has been deleted or removed. |
Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range. The method sets the position of the cursor to the appropriate record, based on the specified direction.
value
of the cursor object is set to a structured clone of the referenced value.code
set to NOT_FOUND_ERR
and a suitable message
.IDBRequest openCursor ( in optional any? range, in optional unsigned short direction ) raises (IDBDatabaseException);
This method can raise an IDBDatabaseException with the following code:
Attribute | Description |
---|---|
TRANSACTION_INACTIVE_ERR | The index's transaction is not active. |
DATA_ERR | The key parameter was not a valid value. |
NOT_ALLOWED_ERR | The request was made on a source object that has been deleted or removed. |
Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range, as arranged by this index. The method sets the position of the cursor to the appropriate record, based on the specified direction.
value
of the cursor object is set to the value of the found record.code
set to NOT_FOUND_ERR
and a suitable message
.IDBRequest openKeyCursor ( in optional any? range, in optional unsigned short direction ) raises (IDBDatabaseException);
This method can raise an IDBDatabaseException with the following code:
Attribute | Description |
---|---|
TRANSACTION_INACTIVE_ERR | The index's transaction is not active. |
DATA_ERR | The key parameter was not a valid value. |
NOT_ALLOWED_ERR | The request was made on a source object that has been deleted or removed. |