汎用方式の要求: Db2®
汎用方式の要求で File Manager ファイルにアクセスするために、Db2® Service Provider は次の JSON を受け入れます。
{
"resource" :
{
"ssid" : "string",
"owner" : "string",
"tableName" : "string",
"dataCcsid" : integer,
"dbcsCcsid" : integer
},
"template" :
{
"templateName" : "string",
"tmplCcsid" : integer
},
"operation" :
{
"numRows" : integer,
"session" : Boolean,
"token" : "string",
"timeout" : integer,
"where" : "string",
"maxRows" : integer
},
"position" :
{
"row" : integer
}
}
汎用方式の要求のキー・フィールドについて、次の表で説明します。
注: (必須) という印が付けられているパラメーターは、初回の要求でのみ必要です。
キー | 説明 |
---|---|
resource | (必須) Db2® データ・リソースに関連するパラメーター。resource パラメーターは、データ・リソースからの単一または初回の読み取りを実行するときにのみ必要です。トークンが渡されるときの後続の読み取り要求では resource パラメーターは必要ありません。 |
ssid | (必須) Db2® サブシステム ID。 |
owner | (必須) Db2® 表の所有者の名前。 |
tableName | (必須) Db2® 表の名前。 |
dataCcsid | リソース英数字データの CCSID。デフォルト値は 037 です。 |
dbcsCcsid | グラフィックまたは 2 バイト・データの CCSID。デフォルト値は 930 です。これは dataCcsid と同じである可能性があり、GRAPHIC および DBCS フィールドをサポートするために必要になります。 |
template | template パラメーターにより Db2® データベースの行がマップされます。template パラメーターは、Db2® リソースから単一または初回の読み取りを実行する場合にのみ必要です。トークンが渡されるときの後続の読み取り要求では template パラメーターは必要ありません。 |
templateName | File Manager/Db2 テンプレートの名前。例: MVS.DATASET(MYTMPL)。 |
tmplCcsid | テンプレートの CCSID。デフォルト値は 037 です。 |
operation | operation パラメーターは、サービス・プロバイダーの動作に影響します。すべての operation パラメーターはオプションですが、パフォーマンス上の理由により、session および token パラメーターの正しい使用を理解するために役立ちます。 |
numRows | 取得する表の行の数。許容範囲は 0 から 10000 です。デフォルトは 1です。 |
session | File Manager/Db2 セッションを継続するか終了するかを示します。値 true はセッションを開始し (まだ開始していない場合)、後続の API 呼び出しにもアクティブ状態を維持するようサービス・プロバイダーに指示します。値 false は API 呼び出しが完了したらセッションを終了するようサービス・プロバイダーに指示します。 |
token | 以前の API 応答で返されるセッション・トークン。トークンはアクティブな FM/Db2 セッションを表し、"session" : true を設定する初回読み取りに続く以降の読み取りに使用できます。"session" : true の初回読み取り要求が成功すると、応答でトークンが返されます。 |
timeout | FM/Db2 表示セッションを終了する前に非アクティブにできる時間 (秒)。0 から 28800 (8 時間) までの任意の値を指定できます。デフォルトは 300 (5 分) です。 この値が server.xml 構成の max_timeout より大きい場合、timeout 値は無視され、max_timeout 値が代わりに使用されます。 |
それぞれの意味は以下のとおりです。 | Db2® セッションの開始時に初回の API 要求で Db2® データ・リソースに適用される有効な Db2® WHERE 文節。where 文節によって、セッションの結果表に影響を与えることができます。このパラメーターは初回の API 要求でのみ有効であり、token と相互に排他的です。 |
maxRows | Db2® セッションの結果表の行の最大数。値 0 によって、最大数なしですべての行が要求されます。 注: 大規模な表または予期される結果表のすべての行を読み取る場合、長い時間がかかる場合があります。 maxRows は token と相互に排他的です。デフォルトは 10000です。 |
position | position パラメーターは、Db2® データ・リソース内の読み取り位置に影響します。要求した場合、サービス・プロバイダーは結果表の指定された行に移動し、次の行を読み取ります。デフォルトは、初回読み取りの場合は 1 であり、後続の読み取りの場合は現在の行の位置です。有効なトークンが渡される場合、読み取りは後続の読み取りとみなされます。 |
row | 結果表内の相対的な行の位置。初回の要求の場合、これには結果セットの開始行を指定できます。 |