Source: srcJsdoc/h5.api.sqldb.js

  1. /*
  2.  * Copyright (C) 2012-2016 NS Solutions Corporation
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  *    http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Unless required by applicable law or agreed to in writing, software
  11.  * distributed under the License is distributed on an "AS IS" BASIS,
  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  * See the License for the specific language governing permissions and
  14.  * limitations under the License.
  15.  *
  16.  * hifive
  17.  */
  19. function Select() {
  20. //
  21. }
  22. function Insert() {
  23. //
  24. }
  25. function Update() {
  26. //
  27. }
  28. function Del() {
  29. //
  30. }
  31. function Sql() {
  32. //
  33. }
  35. /**
  36.  * このオブジェクトに設定された情報からSQLステートメントとパラメータを生成し、SQLを実行します
  37.  * <p>
  38.  * 実行結果は、Promiseオブジェクトのprogress()に指定したコールバック関数または、done()に指定したコールバック関数に、<b>検索結果を保持するインスタンス</b>が返されます。
  39.  * <p>
  40.  * 検索結果へのアクセスは以下のように実行します。
  41.  *
  42.  * <pre>
  43.  *  db.insert('USER', {ID:10, NAME:'TANAKA'}).execute().done(function(rows) {
  44.  * 　rows.item(0).ID     // 検索にマッチした1件目のレコードのID
  45.  * 　rows.item(0).NAME   // 検索にマッチした1件目のレコードのNAME
  46.  *  });
  47.  * </pre>
  48.  *
  49.  * また、progress()に指定したコールバック関数の第二引数には、トランザクションオブジェクトが格納され、このオブジェクトを使用することで、トランザクションを引き継ぐことができます。
  50.  *
  51.  * <pre>
  52.  *  db.select('PRODUCT', ['ID']).where({NAME: 'ball'}).execute().progress(function(rs, tx) {
  53.  * 　db.update('STOCK', {PRICE: 2000}, tx).where({ID: rs.item(0).ID}).execute();
  54.  *  });
  55.  * </pre>
  56.  *
  57.  * db.select().execute()で返ってきたトランザクションを、db.update()の第三引数に指定することで、db.selec()とdb.update()は同一トランザクションで実行されます。
  58.  * <p>
  59.  * <h5>ver1.1.8からの変更点</h5>
  60.  * execute()が返すPromiseオブジェクトのprogressコールバックの第二引数(<b>TransactionalExecutor</b>インスタンス)に、
  61.  * Select/Insert/Del/Update/Sqlインスタンスをaddすることができるようになりました。
  62.  * <p>
  63.  * 下記のサンプルコードは、tx.add()で追加したStatementインスタンスを、一番最初に実行したdb.select()と同一トランザクションでSQLを実行します。
  64.  *
  65.  * <pre>
  66.  *  db.select('PRODUCT', ['ID']).where({NAME:'ballA'}).execute().progress(function(rs, tx) {
  67.  * 　　tx.add(db.select('STOCK', ['COUNT']).where({ID: rs.item(0).ID})).execute().done(function(rows) {
  68.  * 　　　alert(rows.item(0).COUNT);
  69.  * 　　});
  70.  *  });
  71.  * </pre>
  72.  *
  73.  * @function
  74.  * @memberOf Select
  75.  * @returns {Promise} Promiseオブジェクト
  76.  */
  77. Select.prototype.execute = function() {
  78. //
  79. };
  81. /**
  82.  * このオブジェクトに設定された情報からSQLステートメントとパラメータを生成し、SQLを実行します
  83.  * <p>
  84.  * 実行結果は、Promiseオブジェクトのprogress()に指定したコールバック関数または、done()に指定したコールバック関数に、<b>登録に成功したレコードのIDを持つ配列</b>が返されます。
  85.  * <p>
  86.  * 検索結果へのアクセスは以下のように実行します。
  87.  *
  88.  * <pre>
  89.  *  db.insert('USER', {ID:10, NAME:'TANAKA'}).execute().done(function(rows) {
  90.  * 　rows.item(0).ID     // 検索にマッチした1件目のレコードのID
  91.  * 　rows.item(0).NAME   // 検索にマッチした1件目のレコードのNAME
  92.  *  });
  93.  * </pre>
  94.  *
  95.  * また、progress()に指定したコールバック関数の第二引数には、トランザクションオブジェクトが格納され、このオブジェクトを使用することで、トランザクションを引き継ぐことができます。
  96.  *
  97.  * <pre>
  98.  *  db.select('STOCK', {ID:10, NAME:'ballA'}).execute().progress(function(rs, tx) { // ※1
  99.  * 　db.insert('STOCK', {ID:11, NAME:'ballB'}, tx).execute(); // ※2
  100.  *  });
  101.  * </pre>
  102.  *
  103.  * ※1のprogress()で返ってきたトランザクション(tx)を、※2のinsert()の第三引数に指定することで、2つのdb.insert()は同一トランザクションで実行されます。 *
  104.  * <p>
  105.  * <h5>ver1.1.8からの変更点</h5>
  106.  * execute()が返すPromiseオブジェクトのprogressコールバックの第二引数(<b>TransactionalExecutor</b>インスタンス)に、
  107.  * Select/Insert/Del/Update/Sqlインスタンスをaddすることができるようになりました。
  108.  * <p>
  109.  * 下記のサンプルコードは、tx.add()で追加したStatementインスタンスを、一番最初に実行したdb.insert()と同一トランザクションでSQLを実行します。
  110.  *
  111.  * <pre>
  112.  *  db.insert('PRODUCT', {ID:11, NAME:'ballA'}).execute().progress(function(rs, tx) {
  113.  * 　　tx.add(db.insert('PRODUCT', {ID:12, NAME:'ballB'})).execute().done(function() {
  114.  * 　　　alert('success');
  115.  * 　　});
  116.  *  });
  117.  * </pre>
  118.  *
  119.  * @function
  120.  * @memberOf Insert
  121.  * @returns {Promise} Promiseオブジェクト
  122.  */
  123. Insert.prototype.execute = function() {
  124. //
  125. };
  127. /**
  128.  * このオブジェクトに設定された情報からSQLステートメントとパラメータを生成し、SQLを実行します
  129.  * <p>
  130.  * 実行結果は、Promiseオブジェクトのprogress()に指定したコールバック関数または、done()に指定したコールバック関数に、<b>更新されたレコードの件数</b>が返されます。
  131.  *
  132.  * <pre>
  133.  *  db.update('USER', {NAME:TANAKA}).where({ID:10}).execute().done(function(rowsAffected) {
  134.  *  　rowsAffected // 更新されたレコードの行数(Number型)
  135.  *  });
  136.  * </pre>
  137.  *
  138.  * また、progress()に指定したコールバック関数の第二引数には、トランザクションオブジェクトが格納され、このオブジェクトを使用することで、トランザクションを引き継ぐことができます。
  139.  *
  140.  * <pre>
  141.  *  db.select('PRODUCT', ['ID']).where({NAME: 'ball'}).execute().progress(function(rs, tx) {
  142.  * 　db.update('STOCK', {PRICE: 2000}, tx).where({ID: rs.item(0).ID}).execute();
  143.  *  });
  144.  * </pre>
  145.  *
  146.  * db.select().execute()で返ってきたトランザクションを、db.update()の第三引数に指定することで、db.select()とdb.update()は同一トランザクションで実行されます。
  147.  * <p>
  148.  * <h5>ver1.1.8からの変更点</h5>
  149.  * execute()が返すPromiseオブジェクトのprogressコールバックの第二引数(<b>TransactionalExecutor</b>インスタンス)に、
  150.  * Select/Insert/Del/Update/Sqlインスタンスをaddすることができるようになりました。
  151.  * <p>
  152.  * 下記のサンプルコードは、tx.add()で追加したStatementインスタンスを、一番最初に実行したdb.select()と同一トランザクションでSQLを実行します。
  153.  *
  154.  * <pre>
  155.  *  db.select('PRODUCT', ['ID']).where({NAME: 'ballA'}).execute().progress(function(rs, tx) {
  156.  * 　　tx.add(db.update('STOCK', {COUNT: 10}).where({ID: rs.item(0).ID})).execute().done(function() {
  157.  * 　　　alert('success');
  158.  * 　　});
  159.  *  });
  160.  * </pre>
  161.  *
  162.  * @function
  163.  * @memberOf Update
  164.  * @returns {Promise} Promiseオブジェクト
  165.  */
  166. Update.prototype.execute = function() {
  167. //
  168. };
  170. /**
  171.  * このオブジェクトに設定された情報からSQLステートメントとパラメータを生成し、SQLを実行します
  172.  * <p>
  173.  * 実行結果は、Promiseオブジェクトのprogress()に指定したコールバック関数または、done()に指定したコールバック関数に、<b>削除されたレコードの件数</b>が返されます。
  174.  *
  175.  * <pre>
  176.  *  db.del('USER').where({ID:10}).execute().done(function(rowsAffected) {
  177.  *  　rowsAffected // 削除されたレコードの行数(Number型)
  178.  *  });
  179.  * </pre>
  180.  *
  181.  * また、progress()に指定したコールバック関数の第二引数には、トランザクションオブジェクトが格納され、このオブジェクトを使用することで、トランザクションを引き継ぐことができます。
  182.  *
  183.  * <pre>
  184.  *  db.select('PRODUCT', ['ID']).where({NAME: 'ball'}).execute().progress(function(rs, tx) {
  185.  *  　db.del('STOCK', tx).where({ID: rs.item(0).ID}).execute();
  186.  *  });
  187.  * </pre>
  188.  *
  189.  * db.select().execute()で返ってきたトランザクションを、db.del()の第二引数に指定することで、db.select()とdb.del()は同一トランザクションで実行されます。 *
  190.  * <p>
  191.  * <h5>ver1.1.8からの変更点</h5>
  192.  * execute()が返すPromiseオブジェクトのprogressコールバックの第二引数(<b>TransactionalExecutor</b>インスタンス)に、
  193.  * Select/Insert/Del/Update/Sqlインスタンスをaddすることができるようになりました。
  194.  * <p>
  195.  * 下記のサンプルコードは、tx.add()で追加したStatementインスタンスを、一番最初に実行したdb.del()と同一トランザクションでSQLを実行します。
  196.  *
  197.  * <pre>
  198.  *  db.del('USER').where({ID:1}).execute().progress(function(rs, tx) {
  199.  * 　　tx.add(db.del('ROLE').where({ID:1})).execute().done(function() {
  200.  * 　　　alert('success');
  201.  * 　　});
  202.  *  });
  203.  * </pre>
  204.  *
  205.  * @function
  206.  * @memberOf Del
  207.  * @returns {Promise} Promiseオブジェクト
  208.  */
  209. Del.prototype.execute = function() {
  210. //
  211. };
  213. /**
  214.  * このオブジェクトに設定された情報からSQLステートメントとパラメータを生成し、SQLを実行します
  215.  * <p>
  216.  * 実行結果は、戻り値であるPromiseオブジェクトのprogress()に指定したコールバック関数または、done()に指定したコールバック関数に、<b>実行結果を保持するオブジェクト</b>が返されます。
  217.  * <p>
  218.  * 実行結果オブジェクトは、以下のプロパティを持っています。<br>
  219.  * <table border="1">
  220.  * <tr>
  221.  * <td>プロパティ名</td>
  222.  * <td>説明</td>
  223.  * </tr>
  224.  * <tr>
  225.  * <td>rows</td>
  226.  * <td>検索(SELECT)を実行した場合、このプロパティに結果が格納されます。</td>
  227.  * </tr>
  228.  * <tr>
  229.  * <td>insertId</td>
  230.  * <td>登録(INSERT)を実行した場合、このプロパティに登録したレコードのIDが格納されます。</td>
  231.  * </tr>
  232.  * <tr>
  233.  * <td>rowsAffected</td>
  234.  * <td>削除(DELETE)や更新(UPDATE)した場合、このプロパティに変更のあったレコードの件数が格納されます。</td>
  235.  * </tr>
  236.  * </table>
  237.  * <p>
  238.  * 例.検索結果の取得
  239.  *
  240.  * <pre>
  241.  *  db.sql('SELECT * FROM USER').execute().done(function(rs) {
  242.  *  　rs.rows          // SQLResultSetRowList
  243.  *  　rs.insertId      // Number
  244.  *  　rs.rowsAffected  // Number
  245.  *  });
  246.  * </pre>
  247.  *
  248.  * <p>
  249.  * <b>SQLResultSetRowList</b>は、以下のプロパティを持っています。<br>
  250.  * <table border="1">
  251.  * <tr>
  252.  * <td>プロパティ名</td>
  253.  * <td>説明</td>
  254.  * </tr>
  255.  * <tr>
  256.  * <td>length</td>
  257.  * <td>検索にマッチしたレコードの件数</td>
  258.  * </tr>
  259.  * <tr>
  260.  * <td>rows</td>
  261.  * <td>検索結果</td>
  262.  * </tr>
  263.  * </table>
  264.  * <p>
  265.  * 例.検索結果の取得する
  266.  *
  267.  * <pre>
  268.  *  db.sql('SELECT ID, NAME FROM USER').execute().done(function(rs) {
  269.  * 　rs.rows.item(0).ID     // 検索にマッチした1件目のレコードのID
  270.  * 　rs.rows.item(0).NAME   // 検索にマッチした1件目のレコードのNAME
  271.  *  });
  272.  * </pre>
  273.  *
  274.  * また、progress()に指定したコールバック関数の第二引数には、トランザクションオブジェクトが格納され、このオブジェクトを使用することで、トランザクションを引き継ぐことができます。
  275.  * <p>
  276.  * 例.同一トランザクションでdb.insert()とdb.sql()を実行する
  277.  *
  278.  * <pre>
  279.  *  db.select('PRODUCT', ['ID']).where({NAME: 'ball'}).execute().progress(function(rs, tx) {
  280.  * 　db.sql('UPDATE STOCK SET PRICE = 2000', tx).where({ID: rs.item(0).ID}).execute();
  281.  *  });
  282.  * </pre>
  283.  *
  284.  * db.select().execute()で返ってきたトランザクションを、db.sql()の第三引数に指定することで、db.select()とdb.sql()は同一トランザクションで実行されます。 *
  285.  * <p>
  286.  * <h5>ver1.1.8からの変更点</h5>
  287.  * execute()が返すPromiseオブジェクトのprogressコールバックの第二引数(<b>TransactionalExecutor</b>インスタンス)に、
  288.  * Select/Insert/Del/Update/Sqlインスタンスをaddすることができるようになりました。
  289.  * <p>
  290.  * 下記のサンプルコードは、tx.add()で追加したStatementインスタンスを、一番最初に実行したdb.select()と同一トランザクションでSQLを実行します。
  291.  *
  292.  * <pre>
  293.  *  db.select('PRODUCT', ['ID']).where({NAME:'ballA'}).execute().progress(function(rs, tx) {
  294.  * 　　tx.add(db.sql('SELECT COUNT FROM STOCK WHERE ID = '+ rs.item(0).ID')).execute().done(function(rs2) {
  295.  * 　　　alert(rs2.rows.item(0).COUNT);
  296.  * 　　});
  297.  *  });
  298.  * </pre>
  299.  *
  300.  * @function
  301.  * @memberOf Sql
  302.  * @returns {Promise} Promiseオブジェクト
  303.  */
  304. Sql.prototype.execute = function() {
  305. //
  306. };