IDBKeyRange.upperBound()

By default, it includes the upper endpoint value and is closed.

Syntax

myKeyRange = IDBKeyRange.upperBound("Z", true);

Returns

IDBKeyRange: The newly created key range.

Exceptions

This method may raise a DOMException of the following type:

Example

The following example illustrates how you'd use a lower bound key range. Here we declare keyRangeValue = IDBKeyRange.upperBound("M", true); — a range that includes the value "M" and everything before it. 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 "M" and all that come before it. If we used IDBKeyRange.upperBound("M", true);, then the range would not include "M"; only the values before it.

function displayData() {
  var keyRangeValue = IDBKeyRange.upperBound("F");

  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.');
      }
    };
  };

Parameters

bound

The value of the upper bound of the range.

open

Optional. If false (default value), the range includes the lower-bound value.

Specification

Browser compatibility

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.)