Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

Revision 669009 of IDBFactory

  • Revision slug: Web/API/IDBFactory
  • Revision title: IDBFactory
  • Revision id: 669009
  • Created:
  • Creator: chrisdavidmills
  • Is current revision? No
  • Comment

Revision Content

{{APIRef()}}

The IDBFactory interface of the IndexedDB API lets applications asynchronously access the indexed databases. The object that implements the interface is window.indexedDB. You open — that is, create and access — and delete a database with this object, and not directly with IDBFactory.

Methods

{{domxref("IDBFactory.open")}}
The current method to request opening a connection to a database.
IDBFactory.open, the original version {{ obsolete_inline }}
An obsolete method to request opening a connection to a database, still implemented by some browsers.
{{domxref("IDBFactory.deleteDatabase")}}
A method to request the deletion of a database.
{{domxref("IDBFactory.cmp")}}
A method that compares two keys and returns a result indicating which one is greater in value.

Example

In the following code snippet, we open a database asynchronously and make a request:

// In the following line, you should include the prefixes of implementations you want to test.
  window.indexedDB = window.indexedDB || window.mozIndexedDB || window.webkitIndexedDB || window.msIndexedDB;
  // DON'T use "var indexedDB = ..." if you're not in a function.
  // Moreover, you may need references to some window.IDB* objects:
  window.IDBTransaction = window.IDBTransaction || window.webkitIDBTransaction || window.msIDBTransaction;
  window.IDBKeyRange = window.IDBKeyRange || window.webkitIDBKeyRange || window.msIDBKeyRange;
  // (Mozilla has never prefixed these objects, so we don't need window.mozIDB*)

  // Let us open version 4 of our database
  var DBOpenRequest = window.indexedDB.open("toDoList", 4);

  // these two event handlers act on the database being opened successfully, or not
  DBOpenRequest.onerror = function(event) {
    note.innerHTML += '<li>Error loading database.</li>';
  };
 
  DBOpenRequest.onsuccess = function(event) {
    note.innerHTML += '<li>Database initialised.</li>';
    
    // store the result of opening the database in the db variable. This is used a lot later on, for opening transactions and suchlike.
    db = request.result;
  };

Specifications

Specification Status Comment
{{SpecName('IndexedDB', '#idl-def-IDBFactory', 'IDBFactory')}} {{Spec2('IndexedDB')}}  

Browser compatibility

{{ CompatibilityTable() }}

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 12{{property_prefix("webkit")}}
24
{{ CompatGeckoDesktop("10.0") }} 10 17 {{ CompatNo() }}
Feature Android Firefox Mobile (Gecko) Firefox OS IE Phone Opera Mobile Safari Mobile
Basic support 4.4 {{ CompatGeckoMobile("6.0") }} 1.0.1 10 17 {{ CompatNo() }}

 

Be careful in Chrome as it still implements the old specification along the new one. Similarly it still has the prefixed webkitIndexedDB property even if the unprefixed indexedDB is present.

See also

  • Using IndexedDB
  • Starting transactions: {{domxref("IDBDatabase")}}
  • Setting transaction modes: {{domxref("IDBTransaction")}}
  • Setting a range of keys: {{domxref("IDBKeyRange")}}
  • Making changes to your data: {{domxref("IDBIndex")}} and {{domxref("IDBObjectStore")}}
  • Creating cursors: {{domxref("IDBCursor")}}
  • Reference example: To-do Notifications (view example live.)

Revision Source

<p>{{APIRef()}}</p>
<div>
 <p>The <code>IDBFactory</code> interface of the <a href="/en-US/docs/IndexedDB">IndexedDB API</a> lets applications asynchronously access the indexed databases. The object that implements the interface is <code>window.indexedDB</code>. You open — that is, create and access — and delete a database with this object, and not directly with <code>IDBFactory</code>.</p>
</div>
<h2 id="Methods">Methods</h2>
<dl>
 <dt>
  {{domxref("IDBFactory.open")}}</dt>
 <dd>
  The current method to request opening a <a href="https://developer.mozilla.org/en-US/docs/IndexedDB#gloss_database_connection">connection to a database</a>.</dd>
 <dt>
  <code><a href="/en-US/docs/Web/API/IDBFactory.open-obsolete">IDBFactory.open</a></code>, the original version {{ obsolete_inline }}</dt>
 <dd>
  An obsolete method to request opening a <a href="https://developer.mozilla.org/en-US/docs/IndexedDB#gloss_database_connection">connection to a database</a>, still implemented by some browsers.</dd>
 <dt>
  {{domxref("IDBFactory.deleteDatabase")}}</dt>
 <dd>
  A method to request the deletion of a database.</dd>
 <dt>
  {{domxref("IDBFactory.cmp")}}</dt>
 <dd>
  A method that compares two keys and returns a result indicating which one is greater in value.</dd>
</dl>
<h2 id="Example">Example</h2>
<p>In the following code snippet, we open a database asynchronously and make a request:</p>
<pre class="brush:js;highlight:[10]">
// In the following line, you should include the prefixes of implementations you want to test.
&nbsp; window.indexedDB = window.indexedDB || window.mozIndexedDB || window.webkitIndexedDB || window.msIndexedDB;
&nbsp; // DON'T use "var indexedDB = ..." if you're not in a function.
&nbsp; // Moreover, you may need references to some window.IDB* objects:
&nbsp; window.IDBTransaction = window.IDBTransaction || window.webkitIDBTransaction || window.msIDBTransaction;
&nbsp; window.IDBKeyRange = window.IDBKeyRange || window.webkitIDBKeyRange || window.msIDBKeyRange;
&nbsp; // (Mozilla has never prefixed these objects, so we don't need window.mozIDB*)

&nbsp; // Let us open version 4 of our database
&nbsp; var DBOpenRequest = window.indexedDB.open("toDoList", 4);

&nbsp; // these two event handlers act on the database being opened successfully, or not
&nbsp; DBOpenRequest.onerror = function(event) {
&nbsp;&nbsp;&nbsp; note.innerHTML += '&lt;li&gt;Error loading database.&lt;/li&gt;';
&nbsp; };
&nbsp;
&nbsp; DBOpenRequest.onsuccess = function(event) {
&nbsp;&nbsp;&nbsp; note.innerHTML += '&lt;li&gt;Database initialised.&lt;/li&gt;';
&nbsp;&nbsp; &nbsp;
&nbsp;&nbsp;&nbsp; // store the result of opening the database in the db variable. This is used a lot later on, for opening transactions and suchlike.
&nbsp;&nbsp;&nbsp; db = request.result;
&nbsp; };
</pre>
<h2 id="Specifications">Specifications</h2>
<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">Specification</th>
   <th scope="col">Status</th>
   <th scope="col">Comment</th>
  </tr>
  <tr>
   <td>{{SpecName('IndexedDB', '#idl-def-IDBFactory', 'IDBFactory')}}</td>
   <td>{{Spec2('IndexedDB')}}</td>
   <td>&nbsp;</td>
  </tr>
 </tbody>
</table>
<h2 id="Browser_compatibility" name="Browser_compatibility">Browser compatibility</h2>
<p>{{ CompatibilityTable() }}</p>
<div id="compat-desktop">
 <table class="compat-table">
  <tbody>
   <tr>
    <th>Feature</th>
    <th>Chrome</th>
    <th>Firefox (Gecko)</th>
    <th>Internet Explorer</th>
    <th>Opera</th>
    <th>Safari (WebKit)</th>
   </tr>
   <tr>
    <td>Basic support</td>
    <td>12{{property_prefix("webkit")}}<br />
     24</td>
    <td>{{ CompatGeckoDesktop("10.0") }}</td>
    <td>10</td>
    <td>17</td>
    <td>{{ CompatNo() }}</td>
   </tr>
  </tbody>
 </table>
</div>
<div id="compat-mobile">
 <table class="compat-table">
  <tbody>
   <tr>
    <th>Feature</th>
    <th>Android</th>
    <th>Firefox Mobile (Gecko)</th>
    <th>Firefox OS</th>
    <th>IE&nbsp;Phone</th>
    <th>Opera Mobile</th>
    <th>Safari Mobile</th>
   </tr>
   <tr>
    <td>Basic support</td>
    <td>4.4</td>
    <td>{{ CompatGeckoMobile("6.0") }}</td>
    <td>1.0.1</td>
    <td>10</td>
    <td>17</td>
    <td>{{ CompatNo() }}</td>
   </tr>
  </tbody>
 </table>
</div>
<p>&nbsp;</p>
<div class="warning">
 <p>Be careful in Chrome as it still implements the old specification along the new one. Similarly it still has the prefixed <code>webkitIndexedDB</code> property even if the unprefixed <code>indexedDB</code> is present.</p>
</div>
<h2 id="See_also">See also</h2>
<ul>
 <li><a href="/en-US/docs/Web/API/IndexedDB_API/Using_IndexedDB">Using IndexedDB</a></li>
 <li>Starting transactions: {{domxref("IDBDatabase")}}</li>
 <li>Setting transaction modes: {{domxref("IDBTransaction")}}</li>
 <li>Setting a range of keys: {{domxref("IDBKeyRange")}}</li>
 <li>Making changes to your data: {{domxref("IDBIndex")}} and {{domxref("IDBObjectStore")}}</li>
 <li>Creating cursors: {{domxref("IDBCursor")}}</li>
 <li>Reference example: <a class="external" href="https://github.com/mdn/to-do-notifications/tree/gh-pages">To-do Notifications</a> (<a class="external" href="https://mdn.github.io/to-do-notifications/">view example live</a>.)</li>
</ul>
Revert to this revision