TenantDatabaseオブジェクト

• example1.sql

   SELECT * FROM b_m_account_b
   

• example1.js

   var db     = new TenantDatabase();
   var result = db.executeByTemplate('example1');
  
   if (!result.error) {
       result.data.forEach(function(e) {
           Debug.print(e);
       });
   }
   

• example2.sql

   SELECT
     *
   FROM
     b_m_account_b
   WHERE
     user_cd LIKE /*hoge*/'bar' OR user_cd LIKE /*parameters.foo*/'baz'
   

• example2.js

   new TenantDatabase().executeByTemplate('example2', {
       hoge: DbParameter.string('Hoge'),
       foo: DbParameter.string('Foo')
   });
   

• example3.sql

   SELECT
     *
   FROM
     b_m_account_b
   ORDER BY
     /*$hoge*/user_cd
   

• example3.js

   new TenantDatabase().executeByTemplate('example3', {
       hoge: 'locale_id'
   });
   

• example4.sql

   SELECT
     *
   FROM
     b_m_account_b
   WHERE
     user_cd LIKE ? AND
     locale_id LIKE ?
   

• example4.js

   new TenantDatabase().executeByTemplate('example4', {
       $1: DbParameter.string('foo'),
       $2: DbParameter.string('bar')
   });
   

• example5.sql

   SELECT
     *
   FROM
     b_m_account_b
   WHERE
     user_cd IN /*param*/('hoge','foo')
   

• example5.js

   new TenantDatabase().executeByTemplate('example5', {
       param: [
           DbParameter.string('bar'),
           DbParameter.string('baz')
       ]
   });
   

• example6.sql

   SELECT
     *
   FROM
     b_m_account_b
   WHERE
     /*IF doSomething()*/
     user_cd = /*hoge*/'bar'
     /*END*/
     /*IF flag*/
     AND valid_start_date <= /*foo*/'2000-02-22 00:00:00'
     AND /*foo*/'2000-02-22 00:00:00' < valid_end_date
     /*END*/
   

• example6.js

   new TenantDatabase().executeByTemplate('example6', {
       doSomething: function() {
           return true;
       },
       flag: true,
       hoge:  DbParameter.string('bar'),
       foo: DbParameter.date(new Date())
   });
   

• example7.sql

   SELECT
     *
   FROM
     b_m_account_b
   /*BEGIN*/
   WHERE
     /*IF doSomething()*/
     user_cd = /*hoge*/'bar'
     /*END*/
     /*IF flag*/
     AND valid_start_date <= /*foo*/'2000-02-22 00:00:00'
     AND /*foo*/'2000-02-22 00:00:00' < valid_end_date
     /*END*/
   /*END*/
   

• example7.js

   new TenantDatabase().executeByTemplate('example7', {
       doSomething: function() {
           return true;
       },
       flag: true,
       hoge:  DbParameter.string('bar'),
       foo: DbParameter.date(new Date())
   });
   

 CREATE TABLE my_table1(numeric_column numeric)
 INSERT INTO my_table1 VALUES(10)

 CREATE OR REPLACE FUNCTION my_func1()
 RETURNS numeric AS '
     SELECT numeric_column FROM my_table1;
 ' LANGUAGE SQL;

 Transaction.begin(function() {
     var db     = new TenantDatabase();
     var result = db.executeCallable(
         "{ ? = call my_func1() }", // 関数 my_func1 を実行
         [DbParameter.paramOut(DbParameter.TYPE_NUMERIC)] // 関数 my_func1 の戻り値（1個目の「?」パラメータ）は DbParameter.TYPE_NUMERIC（上記表から、PostgreSQL numeric 型のカラムは DbParameter.TYPE_NUMERIC を使用するため）
     );

     if (!result.error) {
         Debug.print(result.params[0]); // 「?」の戻り値は params 変数に返却される。一個目の「?」の戻り値は params[0] に格納される
     }
 });

 CREATE TABLE my_table2(timestamp_column timestamp)
 INSERT INTO my_table2 VALUES('2000-01-01 00:00:00')

 CREATE OR REPLACE FUNCTION my_func2
 RETURN my_table2.timestamp_column%TYPE
 IS
     timestamp_column my_table2.timestamp_column%TYPE;
 BEGIN
     SELECT timestamp_column into timestamp_column FROM my_table2;
     RETURN timestamp_column;
 END my_func2;

 Transaction.begin(function() {
     var db     = new TenantDatabase();
     var result = db.executeCallable(
         "{ ? = call my_func2() }", // 関数 my_func2 を実行
         [DbParameter.paramOut(DbParameter.TYPE_TIMESTAMP)] // 関数 my_func2 の戻り値（1個目の「?」パラメータ）は DbParameter.TYPE_TIMESTAMP（上記表から、Oracle timestamp 型のカラムは DbParameter.TYPE_TIMESTAMP を使用するため）
     );

     if (!result.error) {
         Debug.print(result.params[0]); // 「?」の戻り値は params 変数に返却される。一個目の「?」の戻り値は params[0] に格納される
     }
 });

 CREATE TABLE my_table3(varchar_column varchar(128))
 INSERT INTO my_table3 VALUES('test')

 CREATE FUNCTION my_func3()
 RETURNS varchar(128)
 AS
 BEGIN
     DECLARE @varchar_column varchar(128);
     SELECT @varchar_column = varchar_column FROM my_table3;
     RETURN @varchar_column;
 END;

 Transaction.begin(function() {
     var db     = new TenantDatabase();
     var result = db.executeCallable(
         "{ ? = call my_func3() }", // 関数 my_func3 を実行
         [DbParameter.paramOut(DbParameter.TYPE_STRING)] // 関数 my_func3 の戻り値（1個目の「?」パラメータ）は DbParameter.TYPE_STRING（上記表から、SQL Server varchar 型のカラムは DbParameter.TYPE_STRING を使用するため）
     );

     if (!result.error) {
         Debug.print(result.params[0]); // 「?」の戻り値は params 変数に返却される。一個目の「?」の戻り値は params[0] に格納される
     }
 });

 CREATE TABLE my_table4(numeric_column numeric, varchar_column varchar(128))
 INSERT INTO my_table4 VALUES(1, 'test1')
 INSERT INTO my_table4 VALUES(2, 'test2')

 CREATE OR REPLACE FUNCTION my_func4()
 RETURNS refcursor AS'
 DECLARE
     mycurs refcursor;
 BEGIN
     OPEN mycurs FOR SELECT * FROM my_table4;
 RETURN mycurs;
 END; ' language 'plpgsql'

 Transaction.begin(function() {
     var db     = new TenantDatabase();
     var result = db.executeCallable(
         "{ ? = call my_func4() }", // 関数 my_func4 を実行
         [DbParameter.paramOut(DbParameter.TYPE_CURSOR)] // 関数 my_func4 の戻り値（1個目の「?」パラメータ）は DbParameter.TYPE_CURSOR（上記表から、PostgreSQL refcursor 型のカラムは DbParameter.TYPE_CURSOR を使用するため）
     );

     if (!result.error) {
         // 「?」の戻り値は params 変数に返却される。一個目の「?」の戻り値は params[0] に格納される
         Debug.print(result.params[0][0].numeric_column); // 1
         Debug.print(result.params[0][0].varchar_column); // 'test1'
         Debug.print(result.params[0][1].numeric_column); // 2
         Debug.print(result.params[0][1].varchar_column); // 'test2'
     }
 });

 CREATE TABLE my_table5(number_column number, varchar2_column varchar2(128))
 INSERT INTO my_table5 VALUES(1, 'test1')
 INSERT INTO my_table5 VALUES(2, 'test2')

 CREATE OR REPLACE FUNCTION my_func5
 RETURN SYS_REFCURSOR
 IS
    cur SYS_REFCURSOR;
 BEGIN
    OPEN cur FOR SELECT * FROM my_table5;
    RETURN cur;
 END my_func5;

 Transaction.begin(function() {
     var db     = new TenantDatabase();
     var result = db.executeCallable(
         "{ ? = call my_func5() }", // 関数 my_func5 を実行
         [DbParameter.paramOut(DbParameter.TYPE_CURSOR)] // 関数 my_func5 の戻り値（1個目の「?」パラメータ）は DbParameter.TYPE_CURSOR（上記表から、Oracle refcursor 型のカラムは DbParameter.TYPE_CURSOR を使用するため）
     );

     if (!result.error) {
         // 「?」の戻り値は params 変数に返却される。一個目の「?」の戻り値は params[0] に格納される
         Debug.print(result.params[0][0].number_column);   // 1
         Debug.print(result.params[0][0].varchar2_column); // 'test1'
         Debug.print(result.params[0][1].number_column);   // 2
         Debug.print(result.params[0][1].varchar2_column); // 'test2'
     }
 });

 CREATE TABLE my_table6(numeric_column numeric, varchar_column varchar(128))
 INSERT INTO my_table6 VALUES(1, 'test1')
 INSERT INTO my_table6 VALUES(2, 'test2')

 CREATE PROCEDURE my_proc6
 AS
 BEGIN
     SELECT * FROM my_table6;
 END;

 Transaction.begin(function() {
     var db     = new TenantDatabase();
     var result = db.executeCallable(
         "{ call my_proc6() }" // 関数 my_proc6 を実行（SQL Server の上記のストアドの場合、戻り値は不要）
     );

     if (!result.error) {
         // 戻り値は data 変数に返却される。
         Debug.print(result.data[0].numeric_column); // 1
         Debug.print(result.data[0].varchar_column); // 'test1'
         Debug.print(result.data[1].numeric_column); // 2
         Debug.print(result.data[1].varchar_column); // 'test2'
     }
 });

 CREATE TABLE my_table7_1(numeric_column numeric, varchar_column varchar(128))
 CREATE TABLE my_table7_2(numeric_column numeric, varchar_column varchar(128))
 INSERT INTO my_table7_1 VALUES(1, 'test1')
 INSERT INTO my_table7_1 VALUES(2, 'test2')
 INSERT INTO my_table7_2 VALUES(3, 'test3')
 INSERT INTO my_table7_2 VALUES(4, 'test4')

 CREATE PROCEDURE my_proc7
 AS
 BEGIN
     SELECT * FROM my_table7_1;
     SELECT * FROM my_table7_2;
 END;

 Transaction.begin(function() {
     var db     = new TenantDatabase();
     var result = db.executeCallable(
         "{ call my_proc7() }" // 関数 my_proc7 を実行（SQL Server の上記のストアドの場合、戻り値は不要）
     );

     if (!result.error) {
         // 戻り値は data 変数に返却される。my_table7_1 は data[0] に、my_table7_2 は data[1] に格納される。
         // my_table7_1
         Debug.print(result.data[0][0].numeric_column); // 1
         Debug.print(result.data[0][0].varchar_column); // 'test1'
         Debug.print(result.data[0][1].numeric_column); // 2
         Debug.print(result.data[0][1].varchar_column); // 'test2'
         // my_table7_2
         Debug.print(result.data[1][0].numeric_column); // 3
         Debug.print(result.data[1][0].varchar_column); // 'test3'
         Debug.print(result.data[1][1].numeric_column); // 4
         Debug.print(result.data[1][1].varchar_column); // 'test4'
     }
 });

 CREATE OR REPLACE FUNCTION my_proc8(in param1 text, out param2 text)
 RETURNS text AS $$
 BEGIN
     param2 := param1;
 END;
 $$ LANGUAGE plpgsql;

 Transaction.begin(function() {
     var db     = new TenantDatabase();
     var result = db.executeCallable(
         "{ call my_proc8(?, ?) }", // 関数 my_proc8 を実行
         [
             DbParameter.string('text'), // INパラメータ（上記の表から PostgreSQL text 型のカラムは DbParameter.TYPE_STRING）
             DbParameter.paramOut(DbParameter.TYPE_STRING) // OUTパラメータ（上記の表から PostgreSQL text 型のカラムは DbParameter.TYPE_STRING）
         ]
     );

     if (!result.error) {
         Debug.print(result.params[0]); // "test"（1番目の「?」はINパラメータなので、渡した値がそのままコピーされる）
         Debug.print(result.params[1]); // "test"（2番目の「?」はOUTパラメータなので、出力値が設定される）
     }
 });

 CREATE OR REPLACE PROCEDURE my_proc9(param1 in long raw, param2 out long raw)
 IS
 BEGIN
     param2 := param1;
 END my_proc9;

 Transaction.begin(function() {
     var db     = new TenantDatabase();
     var result = db.executeCallable(
         "{ call my_proc9(?, ?) }", // 関数 my_proc9 を実行
         [
             DbParameter.binary([1, 2, 3]), // INパラメータ（上記の表から Oracle long raw 型のカラムは DbParameter.TYPE_BINARY）
             DbParameter.paramOut(DbParameter.TYPE_BINARY) // OUTパラメータ（上記の表から Oracle long raw 型のカラムは DbParameter.TYPE_BINARY
         ]
     );

     if (!result.error) {
         Debug.print(result.params[0]); // [1, 2, 3]（1番目の「?」はINパラメータなので、渡した値がそのままコピーされる）
         Debug.print(result.params[1]); // [1, 2, 3] をデータとして持つ ByteReader（2番目の「?」はOUTパラメータなので、出力値が設定される）
     }
 });

 CREATE PROCEDURE my_proc10(@param1 bit, @param2 bit OUTPUT)
 AS
 BEGIN
     SET @param2 = @param1;
 END;

 Transaction.begin(function() {
     var db     = new TenantDatabase();
     var result = db.executeCallable(
         "{ call my_proc10(?, ?) }", // 関数 my_proc10 を実行
         [
             DbParameter.boolean(true), // INパラメータ（上記の表から SQL Server bit 型のカラムは DbParameter.TYPE_BOOLEAN
             DbParameter.paramOut(DbParameter.TYPE_BOOLEAN) // OUTパラメータ（上記の表から SQL Server bit 型のカラムは DbParameter.TYPE_BOOLEAN
         ]
     );

     if (!result.error) {
         Debug.print(result.params[0]); // true（1番目の「?」はINパラメータなので、渡した値がそのままコピーされる）
         Debug.print(result.params[1]); // true（2番目の「?」はOUTパラメータなので、出力値が設定される）
     }
 });

 CREATE OR REPLACE FUNCTION my_proc11(inout param varchar)
 RETURNS varchar AS $$
 BEGIN
   param := upper(param);
 END;
 $$ LANGUAGE plpgsql;

 Transaction.begin(function() {
     var db     = new TenantDatabase();
     var result = db.executeCallable(
         "{ call my_proc11(?) }", // 関数 my_proc11 を実行
         [DbParameter.string('test').paramInOut()] // INOUTパラメータ（上記の表から PostgreSQL varchar 型のカラムは DbParameter.TYPE_STRING
     );

     if (!result.error) {
         Debug.print(result.params[0]); // "TEST"（1番目の「?」はINOUTパラメータなので、出力値が設定される）
     }
 });

 CREATE OR REPLACE PROCEDURE my_proc12(param in out varchar2)
 IS
 BEGIN
     param := UPPER(param);
 END my_proc12;

 Transaction.begin(function() {
     var db     = new TenantDatabase();
     var result = db.executeCallable(
         "{ call my_proc12(?) }", // 関数 my_proc12 を実行
         [DbParameter.string('test').paramInOut()] // INOUTパラメータ（上記の表から Oracle varchar2 型のカラムは DbParameter.TYPE_STRING
     );

     if (!result.error) {
         Debug.print(result.params[0]); // "TEST"（1番目の「?」はINOUTパラメータなので、出力値が設定される）
     }
 });

 CREATE PROCEDURE my_proc13(@param varchar(128) OUTPUT)
 AS
 BEGIN
     SET @param = UPPER(@param);
 END;

 Transaction.begin(function() {
     var db     = new TenantDatabase();
     var result = db.executeCallable(
         "{ call my_proc13(?) }", // 関数 my_proc13 を実行
         [DbParameter.string('test').paramInOut()] // INOUTパラメータ（上記の表から SQL Server varchar 型のカラムは DbParameter.TYPE_STRING
     );

     if (!result.error) {
         Debug.print(result.params[0]); // "TEST"（1番目の「?」はINOUTパラメータなので、出力値が設定される）
     }
 });

 CREATE OR REPLACE PROCEDURE my_proc14_1(param in out number)
 IS
 BEGIN
     param := null;
 END my_proc14_1;

 CREATE OR REPLACE PROCEDURE my_proc14_2(param in out float)
 IS
 BEGIN
     param := null;
 END my_proc14_2;

 Transaction.begin(function() {
     var db     = new TenantDatabase();
     var result = db.executeCallable(
         "{ call my_proc14_1(?) }", // 関数 my_proc14_1 を実行
         [DbParameter.numeric(DbParameter.NULL).paramInOut()] // Oracle の number もしくは float の INOUT パラメータに null を渡す際には null ではなく DbParameter.NULL を利用
     );

     if (!result.error) {
         Debug.print(result.params[0]);
     }

     result = db.executeCallable(
         "{ call my_proc14_2(?) }", // 関数 my_proc14_2 を実行
         [DbParameter.numeric(DbParameter.NULL).paramInOut()] // Oracle の number もしくは float の INOUT パラメータに null を渡す際には null ではなく DbParameter.NULL を利用
     );

     if (!result.error) {
         Debug.print(result.params[0]);
     }
 });

• example1.sql

   SELECT * FROM b_m_account_b
   

• example1.js

   var db     = new TenantDatabase();
   var result = db.fetchByTemplate('example1', 1, 10);
  
   if (!result.error) {
       result.data.forEach(function(e) {
           Debug.print(e);
       });
   }
   

• example2.sql

   SELECT
     *
   FROM
     b_m_account_b
   WHERE
     user_cd LIKE /*hoge*/'bar' OR user_cd LIKE /*parameters.foo*/'baz'
   

• example2.js

   new TenantDatabase().fetchByTemplate('example2', 1, 10, {
       hoge: DbParameter.string('Hoge'),
       foo: DbParameter.string('Foo')
   });
   

• example3.sql

   SELECT
     *
   FROM
     b_m_account_b
   ORDER BY
     /*$hoge*/user_cd
   

• example3.js

   new TenantDatabase().fetchByTemplate('example3', 1, 10, {
       hoge: 'locale_id'
   });
   

• example4.sql

   SELECT
     *
   FROM
     b_m_account_b
   WHERE
     user_cd LIKE ? AND
     locale_id LIKE ?
   

• example4.js

   new TenantDatabase().fetchByTemplate('example4', 1, 10, {
       $1: DbParameter.string('foo'),
       $2: DbParameter.string('bar')
   });
   

• example5.sql

   SELECT
     *
   FROM
     b_m_account_b
   WHERE
     user_cd IN /*param*/('hoge', 'foo')
   

• example5.js

   new TenantDatabase().fetchByTemplate('example5', 1, 10, {
       param: [
           DbParameter.string('bar'),
           DbParameter.string('baz')
       ]
   });
   

• example6.sql

   SELECT
     *
   FROM
     b_m_account_b
   WHERE
     /*IF doSomething()*/
     user_cd = /*hoge*/'bar'
     /*END*/
     /*IF flag*/
     AND valid_start_date <= /*foo*/'2000-02-22 00:00:00'
     AND /*foo*/'2000-02-22 00:00:00' < valid_end_date
     /*END*/
   

• example6.js

   new TenantDatabase().fetchByTemplate('example6', 1, 10, {
       doSomething: function() {
           return true;
       },
       flag: true,
       hoge:  DbParameter.string('bar'),
       foo: DbParameter.date(new Date())
   });
   

• example7.sql

   SELECT
     *
   FROM
     b_m_account_b
   /*BEGIN*/
   WHERE
     /*IF doSomething()*/
     user_cd = /*hoge*/'bar'
     /*END*/
     /*IF flag*/
     AND valid_start_date <= /*foo*/'2000-02-22 00:00:00'
     AND /*foo*/'2000-02-22 00:00:00' < valid_end_date
     /*END*/
   /*END*/
   

• example7.js

   new TenantDatabase().fetchByTemplate('example7', 1, 10, {
       doSomething: function() {
           return true;
       },
       flag: true,
       hoge:  DbParameter.string('bar'),
       foo: DbParameter.date(new Date())
   });
   

 var storage = new PublicStorage('sample.txt');

 storage.createAsBinary(function(writer, error) { // PublicStorage に 3 バイトのデータ [97, 98, 99] をもつ sample.txt を作成します。
     if (error != null) {
         throw error;
     }

     writer.write([97, 98, 99]);
 });

 var db = new TenantDatabase();
 var result = db.execute('CREATE TABLE blob_example(blob BLOB)'); // BLOB 型のカラムを持つテーブルを作成します。BLOB に相当する型は各データベース製品で異なることに注意してください。

 if (result.error) {
     throw Error(result.errorMessage);
 }

 storage.openAsBinary(function(reader, error) { // blob へデータを追加します。
     if (error != null) {
         throw error;
     }

     result = db.execute('INSERT INTO blob_example VALUES(?)', [DbParameter.blob(reader)]);
     if (result.error) {
         throw Error(result.errorMessage);
     }
 });

 { // データ読み出し方法1（コールバックを指定する方法）
     db.getByteReader('blob_example', 'blob', '', null, function(result) { // blob からデータを読み取ります。この例のように getByteReader にコールバックを渡す場合ユーザはストリームを close する必要がありません。
         if (result.error) {
             throw Error(result.errorMessage);
         }

         var data = new Array(3);

         result.data.read(data);
         Debug.print(data);
     });
 }

 { // データ読み出し方法2（コールバックを指定しない方法）
     result = db.getByteReader('blob_example', 'blob', ''); // getByteReader にコールバックを渡さずにデータを読み取ります。この呼び出し方法ではユーザは戻り値を忘れずに close する必要があります。
     try {
         if (result.error) {
             throw Error(result.errorMessage);
         }

         var data = new Array(3);

         result.data.read(data);
         Debug.print(data);
     } finally {
         if (result.data != null) {
             result.data.close();
         }
     }
 }
 

 var storage = new PublicStorage('sample.txt');

 storage.createAsText(function(writer, error) { // PublicStorage に 'sample text' という内容をもつ sample.txt を作成します。
     if (error != null) {
         throw error;
     }

     writer.write('sample text');
 });

 var db = new TenantDatabase();
 var result = db.execute('CREATE TABLE clob_example(clob CLOB)'); // CLOB 型のカラムを持つテーブルを作成します。CLOB に相当する型は各データベース製品で異なることに注意してください。

 if (result.error) {
     throw Error(result.errorMessage);
 }

 storage.openAsText(function(reader, error) { // clob へデータを追加します。
     if (error != null) {
         throw error;
     }

     result = db.execute('INSERT INTO clob_example VALUES(?)', [DbParameter.clob(reader)]);
     if (result.error) {
         throw Error(result.errorMessage);
     }
 });

 { // データ読み出し方法1（コールバックを指定する方法）
     db.getTextReader('clob_example', 'clob', '', null, function(result) { // clob からデータを読み取ります。この例のように getTextReader にコールバックを渡す場合ユーザはストリームを close する必要がありません。
         if (result.error) {
             throw Error(result.errorMessage);
         }

         Debug.print(result.data.readLine());
     });
 }

 { // データ読み出し方法2（コールバックを指定しない方法）
     result = db.getTextReader('clob_example', 'clob', ''); // getTextReader にコールバックを渡さずにデータを読み取ります。この呼び出し方法ではユーザは戻り値を忘れずに close する必要があります。
     try {
         if (result.error) {
             throw Error(result.errorMessage);
         }

         Debug.print(result.data.readLine());
     } finally {
         if (result.data != null) {
             result.data.close();
         }
     }
 }
 

 new TenantDatabase().insert('test_table', {
     column1: 'test_value1',
     column2: 123,
     column3: textReader
 });
 

• Oracle Database: NUMBER
• Microsoft SQL Server: decimal, numeric, money, smallmoney
• PostgreSQL: decimal, numeric

 new TenantDatabase().update('test_table', {
     column1: 'test_value1',
     column2: 123,
     column3: textReader
 }, 'column4 LIKE ?', [DbParameter.string('%like%')]);