ydn.db/src/ydn/db/core/storage.js

Javascript database library for IndexedDB, WebDatabase (WebSQL) and WebStorage (localStorage) storage mechanisms supporting version migration, advanced query and transaction workflow.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS-IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.


/**
 * @fileoverview Provide iteration query.
 *
 * @author kyawtun@yathit.com (Kyaw Tun)
 */

goog.provide('ydn.db.core.Storage');
goog.require('ydn.db.core.DbOperator');
goog.require('ydn.db.crud.Storage');



/**
 * Construct storage providing atomic CRUD database operations on implemented
 * storage mechanisms.
 *
 * This class does not execute database operations, but creates a non-overlapping
 * transaction queue on ydn.db.crud.DbOperator and all operations are
 * passed to it.
 *
 *
 * @param {string=} opt_dbname database name
 * @param {(ydn.db.schema.Database|!DatabaseSchema)=} opt_schema database
 * schema
 * or its configuration in JSON format. If not provided, a default empty schema
 * is used.
 * @param {!StorageOptions=} opt_options options.
 * @extends {ydn.db.crud.Storage}
 * @implements {ydn.db.core.IOperator}
 * @constructor
 */
ydn.db.core.Storage = function(opt_dbname, opt_schema, opt_options) {

  goog.base(this, opt_dbname, opt_schema, opt_options);

};
goog.inherits(ydn.db.core.Storage, ydn.db.crud.Storage);


/**
 * Create a new operator.
 * @inheritDoc
 */
ydn.db.core.Storage.prototype.newOperator = function(tx_thread, sync_thread) {
  return new ydn.db.core.DbOperator(this, this.schema, tx_thread, sync_thread);
};


/**
 * Get casted operator.
 * @return {ydn.db.core.DbOperator} casted operator.
 */
ydn.db.core.Storage.prototype.getIndexOperator = function() {
  return /** @type {ydn.db.core.DbOperator} */ (this.db_operator);
};


/**
 *
 * @param {function(this: T, !ydn.db.core.req.ICursor)} callback icursor
 * handler.
 * @param {!ydn.db.Iterator} iter for the cursor.
 * @param {ydn.db.base.TransactionMode=} opt_mode mode.
 * @param {T=} opt_scope optional callback scope.
 * @return {!ydn.db.Request} promise upon completion.
 * @template T
 */
ydn.db.core.Storage.prototype.open = function(callback, iter, opt_mode,
                                              opt_scope) {
  return this.getIndexOperator().open(callback, iter, opt_mode, opt_scope);
};


/**
 * List record in a store.
 * @param {!ydn.db.Iterator} iter iterator
 * @return {!ydn.db.Request} request
 */
ydn.db.core.Storage.prototype.countOf = function(iter) {
  return this.getIndexOperator().countOf(iter);
};


/**
 * List record in a store.
 * @param {!ydn.db.Iterator} iter iterator
 * @param {number=} opt_limit limit
 * @return {!ydn.db.Request} request
 */
ydn.db.core.Storage.prototype.valuesOf = function(iter, opt_limit) {
  return this.getIndexOperator().valuesOf(iter, opt_limit);
};


/**
 * List record in a store.
 * @param {!ydn.db.Iterator} iter iterator
 * @param {number=} opt_limit limit
 * @return {!ydn.db.Request} request
 */
ydn.db.core.Storage.prototype.keysOf = function(iter, opt_limit) {
  return this.getIndexOperator().keysOf(iter, opt_limit);
};


/**
 * Cursor scan iteration.
 * @param {!ydn.db.algo.AbstractSolver|function(!Array, !Array): (Array|undefined)} solver
 * solver
 * @param {!Array.<!ydn.db.Iterator>} iterators for the cursor
 * @return {!goog.async.Deferred} promise upon completion
 */
ydn.db.core.Storage.prototype.scan = function(solver, iterators) {
  return this.getIndexOperator().scan(solver, iterators);
};