pureQuery コードでの静的 SQL のサポートを構成する Default.genProps ファイル内の項目の構文

Default.genProps ファイルは、バインド済み SQL ステートメントを含める DB2® パッケージのオプションを設定するために使用します。

このファイルでは、プロジェクト内のすべてのインターフェースに適用されるオプションを指定できます。個々のインターフェースに固有のオプションも指定できます。

このファイルにはコメントを追加できます。 各コメントの先頭には # 記号を付けます。

項目を作成または編集するときに支援が必要な場合は、CTRL+SPACE キー (このデフォルトのキー・ストロークを変更した場合には独自のキー・ストローク) を押すことができます。

構文図を理解する上で役立つ情報については、構文図の読み方を参照してください。

以下の図は、このファイルでリストされたインターフェースすべてに対するデフォルト・オプションの設定で許可される構文を示します。

構文図を読む構文図をスキップする
>>-defaultOptions--=-------------------------------------------->

>--+---------------------------------------------+-------------->
   '- -baseDataOverride--Java-package.class-name-'   

>--+-----------------------------------+------------------------>
   |               .-NULLID----------. |   
   '- -collection--+-collection-name-+-'   

>--+--------------------------------+--------------------------->
   '- -pkgVersion-- -+-AUTO-------+-'   
                     '-version-ID-'     

>--+---------------------------------------+-------------------->
   |                             .-FALSE-. |   
   '- -forceSingleBindIsolation--+-TRUE--+-'   

>--+---------------------+--+-----------------------+----------><
   '- -xmlFile--XML-file-'  |                   (1) |   
                            '-| Trace options |-----'   

注:
  1. 構文については、以下のオプションの説明を参照してください。

次の構文図は、このファイルでリストされた個々のインターフェースに対するオプションの設定で許可される構文を示します。

構文図を読む構文図をスキップする
>>-Java-package.interface--=------------------------------------>

>--+---------------------------------------------+-------------->
   '- -baseDataOverride--Java-package.class-name-'   

>--+-----------------------------------+------------------------>
   |               .-NULLID----------. |   
   '- -collection--+-collection-name-+-'   

>--+--------------------------------+--------------------------->
   '- -pkgVersion-- -+-AUTO-------+-'   
                     '-version-ID-'     

>--+----------------------------------+------------------------->
   '- -rootPkgName--package-name-stem-'   

>--+---------------------------------------+-------------------->
   |                             .-FALSE-. |   
   '- -forceSingleBindIsolation--+-TRUE--+-'   

>--+---------------------+-------------------------------------><
   '- -xmlFile--XML-file-'   

-baseDataOverride Java-package.class-name
生成されるインプリメンテーション・クラスが拡張する Java クラスの名前を指定できるようにします。 デフォルトでは、生成されるインプリメンテーション・クラスは、クラス com.ibm.pdq.runtime.generator.BaseData を拡張します。 独自のクラスを指定することにより、生成されるインプリメンテーション・クラスを独自のメソッドを使用して拡張できます。
defaultOptions
このファイルにリストされているすべてのインターフェースに入っている SQL ステートメントにこの行のオプションが適用されることを指定します。 このキーワードで始めることができるのは、ファイル内で 1 行だけです。
Java-package.interface (オプション・ファイルの行の先頭で)
指定したインターフェースに入っている SQL ステートメントにのみこの行のオプションが適用されることを指定します。 これらのオプションは、デフォルトとして指定したオプションをオーバーライドします。
インターフェースの名前は、インターフェースが所属する Java パッケージの名前で修飾する必要があります。
-collection collection-name
pureQuery StaticBinder ユーティリティーがバインドするパッケージの修飾子。 修飾子は、使用している DB2 データベースのコレクション名の制約を満たしている必要があります。
このパラメーターを指定しない場合、値のデフォルトは NULLID です。
-pkgVersion AUTO|version-ID
パッケージをバインドするときに使用されるパッケージ・バージョンを指定します。

DB2 では複数のバージョンのパッケージを同時に存在させることができるため、古いバージョンのパッケージを置換することなく、同名の新しいパッケージをバインドできます。 新しいパッケージで問題が発生した場合には、そのパッケージの古いバージョンを使用できます。

このオプションを指定しなかった場合には、それ以降のバインドで作成されるデータベース・パッケージは、バージョンなしで作成されます。

AUTO
現在のタイム・スタンプを使用してバージョンを自動的に生成することを指定します。
version-ID
パッケージのバージョン ID を指定します。ストリングは、使用している DB2 のバージョンで有効なものにする必要があります。
構成ユーティリティーは、ファイル名にバージョン ID を付加して、pureQueryXML ファイルのコピーを作成します。 そのため、バージョン ID には、ご使用のオペレーティング・システムでファイル名として有効な文字のみを含めることができます。 また、ストリングおよびパッケージ名の長さは、ご使用のオペレーティング・システムでファイル名としてサポートされている長さを超えることはできません。

実行時のバージョンの検査は、バージョン名ではなく整合性トークンに基づいて行われます。

-rootPkgName package-name-stem
DB2 パッケージで使用する名前の語幹を指定します。 構成ユーティリティーが DB2 パッケージの名前を作成する方法の詳細については、sqlLimit の説明を参照してください。

package-name-stem は、使用している DB2 データベースで設定された制約の範囲内でなければなりません。

pureQuery StaticBinder ユーティリティーを使用して、 DB2 パッケージを作成するのではなく、DBRM ファイルを生成する場合には、 package-name-stem は、長さが 6 文字以下の大文字にする必要があります。 pureQueryXml ファイルに DDL ステートメントが含まれているか、 (sqlLimit で指定された) パッケージ当たりのステートメント数に到達している場合に、 構成ユーティリティーによって、名前の語幹に文字が追加されます。 StaticBinder ユーティリティーを使用して DBRM ファイルを生成し、package-name-stem構成ユーティリティーのアクティビティーによる追加文字、および分離レベルを組み合わせたストリングが 8 文字より長い場合には、StaticBinder ユーティリティーは例外をスローします。

-forceSingleBindIsolation TRUE|FALSE
単一の分離レベルでのみ DB2 パッケージを作成し、分離レベルを示す数字をパッケージ名に付加しないかどうかを指定します。 デフォルト値は FALSE で、数字標識が付加されます。
このオプションは、Default.bindProps ファイルの -isolationLevel オプションとともに使用します。

-isolationLevel オプションを使用して単一のステートメント・セットを 2 つまたは 3 つの異なるパッケージに、それぞれ異なる分離レベルでバインドする場合、ステートメント・セットが含まれる pureQueryXML ファイルに対して構成ユーティリティーを実行するときは -forceSingleBindIsolation オプションを使用しないでください。

例えば、StaticBinder ユーティリティーのオプション・ファイルに、次の 2 つの項目を組み込んだとします。

C:/dir/captureFile.pdqxml:MYPKGA = -isolationLevel UR
C:/dir/captureFile.pdqxml:MYPKGA = -isolationLevel CS

構成ユーティリティーを captureFile.pdqxml ファイルに対して実行するときに -forceSingleBindIsolation オプションを使用した場合、StaticBinder ユーティリティーは次のアクションを実行します。

  1. UR 分離レベルでパッケージ MYPKGA をバインドします。
  2. CS 分離レベルでパッケージ MYPKGA を再バインドします。

結果として、単一の MYPKGA パッケージは、CS 分離レベルでバインドされます。

バインドの結果が 2 つの MYPKGA パッケージ (1 つは UR 分離レベル、もう 1 つは CS 分離レベルのもの) となるようにする場合は、captureFile.pdqxml に対して構成ユーティリティーを実行するときに -forceSingleBindIsolation オプションを使用しないでください。

Trace options
メッセージのログを記録するファイルおよびログを記録する情報のレベルを指定できます。
構文図を読む構文図をスキップする
>>-+------------------------+--+---------------------------+---><
   '- -traceFile--file-name-'  |               .-OFF-----. |   
                               '- -traceLevel--+-ALL-----+-'   
                                               +-SEVERE--+     
                                               +-WARNING-+     
                                               +-INFO----+     
                                               +-CONFIG--+     
                                               +-FINE----+     
                                               +-FINER---+     
                                               '-FINEST--'     

-traceFile file-name
操作に関する情報のログを記録するために使用するファイルへの絶対パスまたは相対パスとファイル名を指定します。
ファイルが既に存在する場合には、pureQuery は、ファイルの既存の内容に新しいメッセージを追加します。デフォルトでは、項目は System.err に書き込まれます。
-traceLevel OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST|ALL
ログに記録する情報のタイプを指定します。 デフォルトのレベルは OFF です。ログ項目を書き込むファイルを指定せず、このオプションを OFF 以外の値に設定した場合、項目は「コンソール」ビューに書き込まれます。
-xmlFile XML-file
インターフェースで定義されたメソッドの SQL を指定またはオーバーライドする SQL が入っている XML 構成ファイルの名前。 XML 構成ファイルは、対応する Bean の定義もオーバーライドできます。

フィードバック