SQL のアダプタ・メソッドの作成

Method ExecuteUpdate(Output pNumRowsAffected As %Integer,
                pUpdateStatement As %String,
                pParms...) As %Status

INSERT、UPDATE、または DELETE 文を実行します。この文には、使用するパラメータを任意の数だけ渡すことができます。注 ：

• 対象の行数が最初の引数に出力として返されます。

• 2 番目の引数は、実行する INSERT、UPDATE、または DELETE 文です。このクエリ文には、置き換え可能なパラメータを表す標準の SQL ? を使用できます。

Method ExecuteUpdateParmArray(Output pNumRowsAffected As %Integer,
                pUpdateStatement As %String,
                ByRef pParms) As %Status

INSERT、UPDATE、または DELETE 文を実行します。このメソッドは上記のメソッドと似ていますが、パラメータの指定方法が異なります。このメソッドの場合は、この章の前述の “Caché の多次元配列でのパラメータの指定” で説明したとおり、Caché の多次元配列 (pParms) にパラメータを指定します。

ExecuteUpdateParmArray() メソッドは、パラメータを指定する必要があるときに、使用している ODBC ドライバが ODBC SQLDescribeParam 関数をサポートしていない場合に使用します。

Method ExecuteProcedure(ByRef pResultSnapshots As %ListOfObjects,
                Output pOutputParms As %ListOfDataTypes,
                pQueryStatement As %String,
                pIO As %String = "",
                pInputParms...) As %Status

ストアド・プロシージャを実行する SQL CALL 文を実行します。任意の数のパラメータを渡すことができます。注 ：

• 結果は、EnsLib.SQL.SnapshotOpens in a new tab オブジェクトのリストとして、最初の引数に参照渡しで返されます。

• EnsLib.SQL.SnapshotOpens in a new tab の新しいインスタンスのリストを作成し、そのリストを最初の引数としてメソッドに渡すことができます。その場合は、メソッドがこれらのインスタンスを設定し、FirstRow プロパティと MaxRowsToGet プロパティの値を使用してそれぞれに相当する行のセットを選択します。次に、メソッドがインスタンスのリストを返します。

• 2 番目の引数は、すべてのスカラ出力パラメータと入出力パラメータの出力値のリストです。プロシージャがスカラ戻り値を返し、文がそれを取得した場合は、この値が最初の出力値になります。

• 3 番目の引数は、ストアド・プロシージャを実行する SQL CALL 文です。このクエリ文には、置き換え可能なパラメータを表す標準の SQL ? を使用できます。

  Important:

  ストアド・プロシージャ名では大文字と小文字が区別されます。また、SQL クエリが必要とする入力パラメータまたは入出力パラメータごとに、pQueryStatement 文で引数を指定する必要があります。

• 4 番目 (オプション) の引数は、各パラメータのタイプ (入力、出力、または入出力) を示します。この引数を指定する場合は、文字 i、o、および b で構成される文字列を使用します。所定の位置にある文字が、対応するパラメータのタイプを示します。例えば、iob は、最初のパラメータが入力、2 番目のパラメータが出力、および 3 番目のパラメータが入出力であることを意味しています。

  Tip:

  デフォルトでは、アダプタは ODBC 関数 DescribeProcedureColumns を呼び出してパラメータに関する情報を取得し、この関数で返されたパラメータ・タイプとここに指定されているパラメータ・タイプが異なる場合は、警告をログに記録します。アダプタがこのチェックを実行しないようにするには、この文字列の最後にアスタリスク (*) を追加します。

  すべてのデータベースで、これらすべてのパラメータ・タイプがサポートされているわけではありません。接続しているデータベースでサポートされているタイプのみを使用してください。

Method ExecuteProcedureParmArray(ByRef pResultSnapshots As %ListOfObjects,
                Output pOutputParms As %ListOfDataTypes,
                pQueryStatement As %String,
                pIO As %String = "",
                ByRef pIOParms) As %Status

ストアド・プロシージャを実行する SQL CALL 文を実行します。このメソッドは上記のメソッドと似ていますが、パラメータの指定方法が異なります。このメソッドの場合は、この章で前出の “Caché の多次元配列でのパラメータの指定” で説明したとおり、Caché の多次元配列 (pParms) にパラメータを指定します。

ExecuteProcedureParmArray() メソッドは、パラメータを指定する必要があるときに、使用している ODBC ドライバが ODBC SQLDescribeParam 関数をサポートしていない場合に使用します。

以下の点にも注意してください。

• パラメータに関しては、pIOParms 配列内、および　pIO 引数内で入出力タイプを指定した場合は、pIOParms 配列に指定されたタイプが優先されます。

• pIOParms 配列内に入出力タイプを指定する場合は、すべての出力パラメータに対して、対応する配列ノードを未定義のままにします。

SQL アダプタが Java ゲートウェイを介して JDBC を使用するように構成している場合は、ラージ・オブジェクト値が格納されている出力パラメータはストリームとして返されます。旧バージョンの Ensemble との互換性を確保するために、グローバルがこれらのラージ・オブジェクト出力パラメータを文字列として返すように設定できます。ただし、このようにグローバルを設定した場合でも、そのオブジェクトが文字列の最大許容サイズを超えている場合は、ストリームとして返されます。この互換性動作を SQLservice 構成項目に対して設定するには、^Ens.Config("JDBC","LOBasString","SQLservice") というグローバルを 1 に設定します。

Method SetAutoCommit(pAutoCommit) As %Status [ CodeMode = expression ]

このアダプタ接続の自動コミットをオンまたはオフに設定します。これは、DSN 接続の確立後にのみ機能します。

自動コミットを接続時点で設定する場合は、ビジネス・サービスまたはビジネス・オペレーションの OnInit() メソッドをカスタマイズします。カスタム・メソッドで、ConnectAttrs プロパティを設定します。

自動コミットを有効にする場合は、StayConnected を 0 に設定しないでください。この設定は、コマンドを処理している間、リモート・システムに接続したままにしておくかどうかを指定します。

• この設定が SQL 受信アダプタでどのように使用されるかについての詳細は、“SQL 受信アダプタの使用法”　の章の “その他の実行時設定の指定” を参照してください。

• この設定が SQL 送信アダプタでどのように使用されるかについての詳細は、“SQL 送信アダプタの使用法” の章の “その他の実行時設定の指定” を参照してください。

ネットワーク・エラーが検出された場合、デフォルトでは、アダプタは再接続と再試行を試みます。AutoCommit などの接続属性を設定している場合は、次の処理を行って、この再接続/再試行ロジックが実行されるようにしてください。つまり、SetAutoCommit() から返されたステータスをテストし、エラーが生じた場合は、そのステータス値をビジネス・オペレーションから返します。

Method Commit() As %Status

前回のコミット以降の (このアダプタ・プロセス内の) すべてのデータベース・アクティビティをコミットします。

Method Rollback() As %Status

前回のコミット以降の (このアダプタ・プロセス内の) すべてのデータベース・アクティビティ をロールバックします。