UNPKG

lokijs/jsdoc/loki-indexed-adapter.js.html

Version:
1<!DOCTYPE html>
2<html lang="en">
3<head>
  <meta charset="utf-8">
  <title>JSDoc: Source: loki-indexed-adapter.js</title>
6
  <script src="scripts/prettify/prettify.js"> </script>
  <script src="scripts/prettify/lang-css.js"> </script>
  <!--[if lt IE 9]>
    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  <![endif]-->
  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14</head>
15
16<body>
17
18<div id="main">
19
  <h1 class="page-title">Source: loki-indexed-adapter.js</h1>
21
  
23
24
25
  
  <section>
      <article>
          <pre class="prettyprint source linenums"><code>/*
Loki IndexedDb Adapter (need to include this script to use it)
31
Console Usage can be used for management/diagnostic, here are a few examples :
adapter.getDatabaseList(); // with no callback passed, this method will log results to console
adapter.saveDatabase('UserDatabase', JSON.stringify(myDb));
adapter.loadDatabase('UserDatabase'); // will log the serialized db to console
adapter.deleteDatabase('UserDatabase');
37*/
38
39(function (root, factory) {
  if (typeof define === 'function' &amp;&amp; define.amd) {
      // AMD
      define([], factory);
  } else if (typeof exports === 'object') {
      // Node, CommonJS-like
      module.exports = factory();
  } else {
      // Browser globals (root is window)
      root.LokiIndexedAdapter = factory();
  }
50}(this, function () {
return (function() {
52
  /**
   * Loki persistence adapter class for indexedDb.
   *     This class fulfills abstract adapter interface which can be applied to other storage methods. 
   *     Utilizes the included LokiCatalog app/key/value database for actual database persistence.
   *     Indexeddb is highly async, but this adapter has been made 'console-friendly' as well.
   *     Anywhere a callback is omitted, it should return results (if applicable) to console.
   *     IndexedDb storage is provided per-domain, so we implement app/key/value database to 
   *     allow separate contexts for separate apps within a domain.
   *
   * @example
   * var idbAdapter = new LokiIndexedAdapter('finance');
   *
   * @constructor LokiIndexedAdapter
   *
   * @param {string} appname - (Optional) Application name context can be used to distinguish subdomains, 'loki' by default
   */
  function LokiIndexedAdapter(appname)
  {
    this.app = 'loki';
72
    if (typeof (appname) !== 'undefined')
    {
      this.app = appname;
    }
77
    // keep reference to catalog class for base AKV operations
    this.catalog = null;
80
    if (!this.checkAvailability()) {
      throw new Error('indexedDB does not seem to be supported for your environment');
    }
  }
85
  /**
   * Used to check if adapter is available
   *
   * @returns {boolean} true if indexeddb is available, false if not.
   * @memberof LokiIndexedAdapter
   */
  LokiIndexedAdapter.prototype.checkAvailability = function()
  {
    if (typeof indexedDB !== 'undefined' &amp;&amp; indexedDB) return true;
95
    return false;
  };
98
  /**
   * Retrieves a serialized db string from the catalog.
   *
   * @example
   * // LOAD
   * var idbAdapter = new LokiIndexedAdapter('finance');
   * var db = new loki('test', { adapter: idbAdapter });
   *   db.loadDatabase(function(result) {
   *   console.log('done');
   * });
   *
   * @param {string} dbname - the name of the database to retrieve.
   * @param {function} callback - callback should accept string param containing serialized db string.
   * @memberof LokiIndexedAdapter
   */
  LokiIndexedAdapter.prototype.loadDatabase = function(dbname, callback)
  {
    var appName = this.app;
    var adapter = this;
118
    // lazy open/create db reference so dont -need- callback in constructor
    if (this.catalog === null || this.catalog.db === null) {
      this.catalog = new LokiCatalog(function(cat) {
        adapter.catalog = cat;
123
        adapter.loadDatabase(dbname, callback);
      });
126
      return;
    }
129
    // lookup up db string in AKV db
    this.catalog.getAppKey(appName, dbname, function(result) {
      if (typeof (callback) === 'function') {
        if (result.id === 0) {
          callback(null);
          return;
        }
        callback(result.val);
      }
      else {
        // support console use of api
        console.log(result.val);
      }
    });
  };
145
  // alias
  LokiIndexedAdapter.prototype.loadKey = LokiIndexedAdapter.prototype.loadDatabase;
148
  /**
   * Saves a serialized db to the catalog.
   *
   * @example
   * // SAVE : will save App/Key/Val as 'finance'/'test'/{serializedDb}
   * var idbAdapter = new LokiIndexedAdapter('finance');
   * var db = new loki('test', { adapter: idbAdapter });
   * var coll = db.addCollection('testColl');
   * coll.insert({test: 'val'});
   * db.saveDatabase();  // could pass callback if needed for async complete
   *
   * @param {string} dbname - the name to give the serialized database within the catalog.
   * @param {string} dbstring - the serialized db string to save.
   * @param {function} callback - (Optional) callback passed obj.success with true or false
   * @memberof LokiIndexedAdapter
   */
  LokiIndexedAdapter.prototype.saveDatabase = function(dbname, dbstring, callback)
  {
    var appName = this.app;
    var adapter = this;
169
    function saveCallback(result) {
      if (result &amp;&amp; result.success === true) {
        callback(null);
      }
      else {
        callback(new Error("Error saving database"));
      }
    }
178
    // lazy open/create db reference so dont -need- callback in constructor
    if (this.catalog === null || this.catalog.db === null) {
      this.catalog = new LokiCatalog(function(cat) {
        adapter.catalog = cat;
183
        // now that catalog has been initialized, set (add/update) the AKV entry
        cat.setAppKey(appName, dbname, dbstring, saveCallback);
      });
187
      return;
    }
190
    // set (add/update) entry to AKV database
    this.catalog.setAppKey(appName, dbname, dbstring, saveCallback);
  };
194
  // alias
  LokiIndexedAdapter.prototype.saveKey = LokiIndexedAdapter.prototype.saveDatabase;
197
  /**
   * Deletes a serialized db from the catalog.
   *
   * @example
   * // DELETE DATABASE
   * // delete 'finance'/'test' value from catalog
   * idbAdapter.deleteDatabase('test', function {
   *   // database deleted
   * });
   *
   * @param {string} dbname - the name of the database to delete from the catalog.
   * @param {function=} callback - (Optional) executed on database delete
   * @memberof LokiIndexedAdapter
   */
  LokiIndexedAdapter.prototype.deleteDatabase = function(dbname, callback)
  {
    var appName = this.app;
    var adapter = this;
216
    // lazy open/create db reference and pass callback ahead
    if (this.catalog === null || this.catalog.db === null) {
      this.catalog = new LokiCatalog(function(cat) {
        adapter.catalog = cat;
221
        adapter.deleteDatabase(dbname, callback);
      });
224
      return;
    }
227
    // catalog was already initialized, so just lookup object and delete by id
    this.catalog.getAppKey(appName, dbname, function(result) {
      var id = result.id;
231
      if (id !== 0) {
        adapter.catalog.deleteAppKey(id);
      }
235
      if (typeof (callback) === 'function') {
        callback();
      }
    });
  };
241
  // alias
  LokiIndexedAdapter.prototype.deleteKey = LokiIndexedAdapter.prototype.deleteDatabase;
244
  /**
   * Removes all database partitions and pages with the base filename passed in.
   * This utility method does not (yet) guarantee async deletions will be completed before returning
   *
   * @param {string} dbname - the base filename which container, partitions, or pages are derived
   * @memberof LokiIndexedAdapter
   */
  LokiIndexedAdapter.prototype.deleteDatabasePartitions = function(dbname) {
    var self=this;
    this.getDatabaseList(function(result) {
      result.forEach(function(str) {
        if (str.startsWith(dbname)) {
          self.deleteDatabase(str);
        }
      });
    });
  };
262
  /**
   * Retrieves object array of catalog entries for current app.
   *
   * @example
   * idbAdapter.getDatabaseList(function(result) {
   *   // result is array of string names for that appcontext ('finance')
   *   result.forEach(function(str) {
   *     console.log(str);
   *   });
   * });
   *
   * @param {function} callback - should accept array of database names in the catalog for current app.
   * @memberof LokiIndexedAdapter
   */
  LokiIndexedAdapter.prototype.getDatabaseList = function(callback)
  {
    var appName = this.app;
    var adapter = this;
281
    // lazy open/create db reference so dont -need- callback in constructor
    if (this.catalog === null || this.catalog.db === null) {
      this.catalog = new LokiCatalog(function(cat) {
        adapter.catalog = cat;
286
        adapter.getDatabaseList(callback);
      });
289
      return;
    }
292
    // catalog already initialized
    // get all keys for current appName, and transpose results so just string array
    this.catalog.getAppKeys(appName, function(results) {
      var names = [];
297
      for(var idx = 0; idx &lt; results.length; idx++) {
        names.push(results[idx].key);
      }
301
      if (typeof (callback) === 'function') {
        callback(names);
      }
      else {
        names.forEach(function(obj) {
          console.log(obj);
        });
      }
    });
  };
312
  // alias
  LokiIndexedAdapter.prototype.getKeyList = LokiIndexedAdapter.prototype.getDatabaseList;
315
  /**
   * Allows retrieval of list of all keys in catalog along with size
   *
   * @param {function} callback - (Optional) callback to accept result array.
   * @memberof LokiIndexedAdapter
   */
  LokiIndexedAdapter.prototype.getCatalogSummary = function(callback)
  {
    var appName = this.app;
    var adapter = this;
326
    // lazy open/create db reference
    if (this.catalog === null || this.catalog.db === null) {
      this.catalog = new LokiCatalog(function(cat) {
        adapter.catalog = cat;
331
        adapter.getCatalogSummary(callback);
      });
334
      return;
    }
337
    // catalog already initialized
    // get all keys for current appName, and transpose results so just string array
    this.catalog.getAllKeys(function(results) {
      var entries = [];
      var obj,
        size,
        oapp,
        okey,
        oval;
347
      for(var idx = 0; idx &lt; results.length; idx++) {
        obj = results[idx];
        oapp = obj.app || '';
        okey = obj.key || '';
        oval = obj.val || '';
353
        // app and key are composited into an appkey column so we will mult by 2
        size = oapp.length * 2 + okey.length * 2 + oval.length + 1;
356
        entries.push({ "app": obj.app, "key": obj.key, "size": size });
      }
359
      if (typeof (callback) === 'function') {
        callback(entries);
      }
      else {
        entries.forEach(function(obj) {
          console.log(obj);
        });
      }
    });
  };
370
  /**
   * LokiCatalog - underlying App/Key/Value catalog persistence
   *    This non-interface class implements the actual persistence.
   *    Used by the IndexedAdapter class.
   */
  function LokiCatalog(callback)
  {
    this.db = null;
    this.initializeLokiCatalog(callback);
  }
381
  LokiCatalog.prototype.initializeLokiCatalog = function(callback) {
    var openRequest = indexedDB.open('LokiCatalog', 1);
    var cat = this;
385
    // If database doesn't exist yet or its version is lower than our version specified above (2nd param in line above)
    openRequest.onupgradeneeded = function(e) {
      var thisDB = e.target.result;
      if (thisDB.objectStoreNames.contains('LokiAKV')) {
        thisDB.deleteObjectStore('LokiAKV');
      }
392
      if(!thisDB.objectStoreNames.contains('LokiAKV')) {
        var objectStore = thisDB.createObjectStore('LokiAKV', { keyPath: 'id', autoIncrement:true });
        objectStore.createIndex('app', 'app', {unique:false});
        objectStore.createIndex('key', 'key', {unique:false});
        // hack to simulate composite key since overhead is low (main size should be in val field)
        // user (me) required to duplicate the app and key into comma delimited appkey field off object
        // This will allow retrieving single record with that composite key as well as
        // still supporting opening cursors on app or key alone
        objectStore.createIndex('appkey', 'appkey', {unique:true});
      }
    };
404
    openRequest.onsuccess = function(e) {
      cat.db = e.target.result;
407
      if (typeof (callback) === 'function') callback(cat);
    };
410
    openRequest.onerror = function(e) {
      throw e;
    };
  };
415
  LokiCatalog.prototype.getAppKey = function(app, key, callback) {
    var transaction = this.db.transaction(['LokiAKV'], 'readonly');
    var store = transaction.objectStore('LokiAKV');
    var index = store.index('appkey');
    var appkey = app + "," + key;
    var request = index.get(appkey);
422
    request.onsuccess = (function(usercallback) {
      return function(e) {
        var lres = e.target.result;
426
        if (lres === null || typeof(lres) === 'undefined') {
          lres = {
            id: 0,
            success: false
          };
        }
433
        if (typeof(usercallback) === 'function') {
          usercallback(lres);
        }
        else {
          console.log(lres);
        }
      };
    })(callback);
442
    request.onerror = (function(usercallback) {
      return function(e) {
        if (typeof(usercallback) === 'function') {
          usercallback({ id: 0, success: false });
        }
        else {
          throw e;
        }
      };
    })(callback);
  };
454
  LokiCatalog.prototype.getAppKeyById = function (id, callback, data) {
    var transaction = this.db.transaction(['LokiAKV'], 'readonly');
    var store = transaction.objectStore('LokiAKV');
    var request = store.get(id);
459
    request.onsuccess = (function(data, usercallback){
      return function(e) {
        if (typeof(usercallback) === 'function') {
          usercallback(e.target.result, data);
        }
        else {
          console.log(e.target.result);
        }
      };
    })(data, callback);
  };
471
  LokiCatalog.prototype.setAppKey = function (app, key, val, callback) {
    var transaction = this.db.transaction(['LokiAKV'], 'readwrite');
    var store = transaction.objectStore('LokiAKV');
    var index = store.index('appkey');
    var appkey = app + "," + key;
    var request = index.get(appkey);
478
    // first try to retrieve an existing object by that key
    // need to do this because to update an object you need to have id in object, otherwise it will append id with new autocounter and clash the unique index appkey
    request.onsuccess = function(e) {
      var res = e.target.result;
483
      if (res === null || res === undefined) {
        res = {
          app:app,
          key:key,
          appkey: app + ',' + key,
          val:val
        };
      }
      else {
        res.val = val;
      }
495
      var requestPut = store.put(res);
497
      requestPut.onerror = (function(usercallback) {
        return function(e) {
          if (typeof(usercallback) === 'function') {
            usercallback({ success: false });
          }
          else {
            console.error('LokiCatalog.setAppKey (set) onerror');
            console.error(request.error);
          }
        };
508
      })(callback);
510
      requestPut.onsuccess = (function(usercallback) {
        return function(e) {
          if (typeof(usercallback) === 'function') {
            usercallback({ success: true });
          }
        };
      })(callback);
    };
519
    request.onerror = (function(usercallback) {
      return function(e) {
        if (typeof(usercallback) === 'function') {
          usercallback({ success: false });
        }
        else {
          console.error('LokiCatalog.setAppKey (get) onerror');
          console.error(request.error);
        }
      };
    })(callback);
  };
532
  LokiCatalog.prototype.deleteAppKey = function (id, callback) {
    var transaction = this.db.transaction(['LokiAKV'], 'readwrite');
    var store = transaction.objectStore('LokiAKV');
    var request = store.delete(id);
537
    request.onsuccess = (function(usercallback) {
      return function(evt) {
        if (typeof(usercallback) === 'function') usercallback({ success: true });
      };
    })(callback);
543
    request.onerror = (function(usercallback) {
      return function(evt) {
        if (typeof(usercallback) === 'function') {
          usercallback(false);
        }
        else {
          console.error('LokiCatalog.deleteAppKey raised onerror');
          console.error(request.error);
        }
      };
    })(callback);
  };
556
  LokiCatalog.prototype.getAppKeys = function(app, callback) {
    var transaction = this.db.transaction(['LokiAKV'], 'readonly');
    var store = transaction.objectStore('LokiAKV');
    var index = store.index('app');
561
    // We want cursor to all values matching our (single) app param
    var singleKeyRange = IDBKeyRange.only(app);
564
    // To use one of the key ranges, pass it in as the first argument of openCursor()/openKeyCursor()
    var cursor = index.openCursor(singleKeyRange);
567
    // cursor internally, pushing results into this.data[] and return
    // this.data[] when done (similar to service)
    var localdata = [];
571
    cursor.onsuccess = (function(data, callback) {
      return function(e) {
        var cursor = e.target.result;
        if (cursor) {
          var currObject = cursor.value;
577
          data.push(currObject);
579
          cursor.continue();
        }
        else {
          if (typeof(callback) === 'function') {
            callback(data);
          }
          else {
            console.log(data);
          }
        }
      };
    })(localdata, callback);
592
    cursor.onerror = (function(usercallback) {
      return function(e) {
        if (typeof(usercallback) === 'function') {
          usercallback(null);
        }
        else {
          console.error('LokiCatalog.getAppKeys raised onerror');
          console.error(e);
        }
      };
    })(callback);
604
  };
606
  // Hide 'cursoring' and return array of { id: id, key: key }
  LokiCatalog.prototype.getAllKeys = function (callback) {
    var transaction = this.db.transaction(['LokiAKV'], 'readonly');
    var store = transaction.objectStore('LokiAKV');
    var cursor = store.openCursor();
612
    var localdata = [];
614
    cursor.onsuccess = (function(data, callback) {
      return function(e) {
        var cursor = e.target.result;
        if (cursor) {
          var currObject = cursor.value;
620
          data.push(currObject);
622
          cursor.continue();
        }
        else {
          if (typeof(callback) === 'function') {
            callback(data);
          }
          else {
            console.log(data);
          }
        }
      };
    })(localdata, callback);
635
    cursor.onerror = (function(usercallback) {
      return function(e) {
        if (typeof(usercallback) === 'function') usercallback(null);
      };
    })(callback);
641
  };
643
  return LokiIndexedAdapter;
645
}());
647}));
648</code></pre>
      </article>
  </section>
651
652
653
654
655</div>
656
657<nav>
  <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Collection.html">Collection</a></li><li><a href="DynamicView.html">DynamicView</a></li><li><a href="Loki.html">Loki</a></li><li><a href="LokiEventEmitter.html">LokiEventEmitter</a></li><li><a href="LokiFsAdapter.html">LokiFsAdapter</a></li><li><a href="LokiFsStructuredAdapter.html">LokiFsStructuredAdapter</a></li><li><a href="LokiIndexedAdapter.html">LokiIndexedAdapter</a></li><li><a href="LokiLocalStorageAdapter.html">LokiLocalStorageAdapter</a></li><li><a href="LokiMemoryAdapter.html">LokiMemoryAdapter</a></li><li><a href="LokiPartitioningAdapter.html">LokiPartitioningAdapter</a></li><li><a href="Resultset.html">Resultset</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-Autoupdating Collections.html">Autoupdating Collections</a></li><li><a href="tutorial-Changes API.html">Changes API</a></li><li><a href="tutorial-Collection Transforms.html">Collection Transforms</a></li><li><a href="tutorial-Indexing and Query performance.html">Indexing and Query performance</a></li><li><a href="tutorial-Loki Angular.html">Loki Angular</a></li><li><a href="tutorial-Persistence Adapters.html">Persistence Adapters</a></li><li><a href="tutorial-Query Examples.html">Query Examples</a></li></ul>
659</nav>
660
661<br class="clear">
662
663<footer>
  Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Sun Dec 18 2016 19:39:51 GMT-0500 (Eastern Standard Time)
665</footer>
666
667<script> prettyPrint(); </script>
668<script src="scripts/linenumber.js"> </script>
669</body>
670</html>
1	`<!DOCTYPE html>`
2	`<html lang="en">`
3	`<head>`
4	`<meta charset="utf-8">`
5	`<title>JSDoc: Source: loki-indexed-adapter.js</title>`
6
7	`<script src="scripts/prettify/prettify.js"> </script>`
8	`<script src="scripts/prettify/lang-css.js"> </script>`
9	`<!--[if lt IE 9]>`
10	`<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>`
11	`<![endif]-->`
12	`<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">`
13	`<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">`
14	`</head>`
15
16	`<body>`
17
18	`<div id="main">`
19
20	`<h1 class="page-title">Source: loki-indexed-adapter.js</h1>`
21
22
23
24
25
26
27	`<section>`
28	`<article>`
29	`<pre class="prettyprint source linenums"><code>/*`
30	`Loki IndexedDb Adapter (need to include this script to use it)`
31
32	`Console Usage can be used for management/diagnostic, here are a few examples :`
33	`adapter.getDatabaseList(); // with no callback passed, this method will log results to console`
34	`adapter.saveDatabase('UserDatabase', JSON.stringify(myDb));`
35	`adapter.loadDatabase('UserDatabase'); // will log the serialized db to console`
36	`adapter.deleteDatabase('UserDatabase');`
37	`*/`
38
39	`(function (root, factory) {`
40	`if (typeof define === 'function' && define.amd) {`