The only()
method of the IDBKeyRange
interface creates a new key range containing a single value.
Syntax
var myIDBKeyRange = IDBKeyRange.only(value);
Parameters
value is the value for the new key range.
Return value
IDBKeyRange
: The newly created key range.
Exceptions
This method may raise a DOMException
of the following types:
Exception | Description |
---|---|
DataError |
The value parameter passed was not a valid key. |
Example
The following example illustrates how you'd use an only key range. Here we declare a keyRangeValue = IDBKeyRange.only("A");
— a range that only includes the value "A". We open a transaction (using IDBTransaction
) and an object store, and open a Cursor with IDBObjectStore.openCursor
, declaring keyRangeValue
as its optional key range value. This means that the cursor will only retrieve the record with the key value "A".
Note: For a more complete example allowing you to experiment with key range, have a look at our IDBKeyRange repo (view the example live too.)
function displayData() { var keyRangeValue = IDBKeyRange.only("A"); var transaction = db.transaction(['fThings'], 'readonly'); var objectStore = transaction.objectStore('fThings'); objectStore.openCursor(keyRangeValue).onsuccess = function(event) { var cursor = event.target.result; if(cursor) { var listItem = document.createElement('li'); listItem.innerHTML = '<strong>' + cursor.value.fThing + '</strong>, ' + cursor.value.fRating; list.appendChild(listItem); cursor.continue(); } else { console.log('Entries all displayed.'); } }; };
Specification
Specification | Status | Comment |
---|---|---|
Indexed Database API 2.0 The definition of 'only' in that specification. |
Recommendation | |
Indexed Database API Draft The definition of 'only' in that specification. |
Recommendation |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
only | Chrome
Full support
24
| Edge Full support 12 | Firefox
Full support
16
| IE Partial support 10 | Opera Full support 15 | Safari Full support 7 | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support 22 | Opera Android Full support 14 | Safari iOS Full support 8 | Samsung Internet Android Full support Yes |
Legend
- Full support
- Full support
- Partial support
- Partial support
- Requires a vendor prefix or different name for use.
- Requires a vendor prefix or different name for use.
See also
- Using IndexedDB
- Starting transactions:
IDBDatabase
- Using transactions:
IDBTransaction
- Setting a range of keys:
IDBKeyRange
- Retrieving and making changes to your data:
IDBObjectStore
- Using cursors:
IDBCursor
- Reference example: To-do Notifications (view example live.)