特定方式の要求: Db2®
File Manager データの特定方式の要求では、Db2®™ Service Provider は次の JSON を受け入れます。
{
"operation" :
{
"numRows" : integer,
"session" : Boolean,
"token" : "string",
"where" : "string",
"maxRows" : integer
},
"position" :
{
"row" : integer
}
}
特定方式の要求のキー・フィールドについて、次の表で説明します。
キー | 説明 |
---|---|
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 の初回読み取り要求が成功すると、応答でトークンが返されます。 |
それぞれの意味は以下のとおりです。 | Db2® セッションの開始時に初回の API 要求で Db2® データ・リソースに適用される有効な Db2® WHERE 文節。where 文節によって、セッションの結果表に影響を与えることができます。このパラメーターは初回の API 要求でのみ有効であり、token と相互に排他的です。 |
maxRows | Db2® セッションの結果表の行の最大数。値 0 によって、最大数なしですべての行が要求されます。 注: 大規模な表または予期される結果表のすべての行を読み取る場合、長い時間がかかる場合があります。 maxRows は token と相互に排他的です。デフォルトは 10000です。 |
position | position パラメーターは、Db2® データ・リソース内の読み取り位置に影響します。要求した場合、サービス・プロバイダーは結果表の指定された行に移動し、次の行を読み取ります。デフォルトは、初回読み取りの場合は 1 であり、後続の読み取りの場合は現在の行の位置です。有効なトークンが渡される場合、読み取りは後続の読み取りとみなされます。 |
row | 結果表内の相対的な行の位置。初回の要求の場合、これには結果セットの開始行を指定できます。 |