sp_cursoropen (Transact-SQL)

stmt でストアド プロシージャの実行を指定する場合、入力パラメーターは、stmt の文字列の中で定数として定義することも、boundparam 引数として指定することもできます。これにより、宣言された変数を、バインドされたパラメーターとして渡すことができます。

stmt パラメーターで使用できる内容は、次のように、ccopt の戻り値 ALLOW_DIRECT が残りの ccopt 値と OR で結合されているかどうかによって異なります。

• ALLOW_DIRECT が指定されていない場合は、単一の SELECT ステートメントを含むストアド プロシージャを要求する Transact-SQL SELECT ステートメントまたは EXECUTE ステートメントを使用する必要があります。その SELECT ステートメントがカーソルの条件を満たしている必要もあります (キーワード SELECT INTO、FOR BROWSE、および COMPUTE を含むことができません)。

• ALLOW_DIRECT が指定されている場合は、1 つ以上の Transact-SQL ステートメント (複数のステートメントを含む他のストアド プロシージャを実行するものを含む) が実行される可能性があります。SELECT 以外のステートメントや、キーワード SELECT INTO、FOR BROWSE、または COMPUTE を含む SELECT ステートメントは、単純に実行され、カーソルは作成されません。複数のステートメントのバッチに含まれている SELECT ステートメントについても同様です。カーソルのみに関連する句が SELECT ステートメントに含まれている場合、それらの句は無視されます。たとえば、ccopt の値が 0x2002 の場合は、次のいずれかが要求されます。

  • スクロール ロックを使用するカーソル (カーソルの条件を満たしている単一の SELECT ステートメントだけがある場合)。

  • ステートメントの直接実行 (複数のステートメントがある場合、SELECT 以外の単一のステートメントがある場合、またはカーソルの条件を満たしていない SELECT ステートメントがある場合)。

scrollopt の最初の 5 つの値 (KEYSEY、DYNAMIC、FORWARD_ONLY、STATIC、および FAST_FORWARD) は、同時に指定できません。

PARAMETERIZED_STMT と CHECK_ACCEPTED_TYPES は、最初の 5 つの値と OR で結合できます。

AUTO_FETCH と AUTO_CLOSE は、FAST_FORWARD と OR で結合できます。

CHECK_ACCEPTED_TYPES が ON の場合は、scrollopt の最後の 5 つの値 (KEYSET_ACCEPTABLE、DYNAMIC_ACCEPTABLE、FORWARD_ONLY_ACCEPTABLE、STATIC_ACCEPTABLE、または FAST_FORWARD_ACCEPTABLE) の少なくとも 1 つが ON である必要があります。

STATIC カーソルは常に READ_ONLY として開かれます。したがって、このカーソルを使用して基になるテーブルを更新することはできません。

ccopt の最初の 4 つの値 (READ_ONLY、SCROLL_LOCKS、および 2 つの OPTIMISTIC 値) は、同時に指定できません。

注
ccopt の最初の 4 つの値のどれを選択するかによって、カーソルを読み取り専用にするかどうかや、更新データの喪失を防ぐためにロックやオプティミスティックの方法を使用するかどうかが決まります。ccopt の値を指定しない場合の既定値は OPTIMISTIC です。

ALLOW_DIRECT と CHECK_ACCEPTED_TYPES は、最初の 4 つの値と OR で結合できます。

UPDT_IN_PLACE は、READ_ONLY、SCROLL_LOCKS、またはいずれかの OPTIMISTIC 値と OR で結合できます。

CHECK_ACCEPTED_TYPES が ON の場合は、ccopt の最後の 4 つの値 (READ_ONLY_ACCEPTABLE、SCROLL_LOCKS_ACCEPTABLE、またはいずれかの OPTIMISTIC_ACCEPTABLE 値) の少なくとも 1 つが ON である必要があります。

位置指定の UPDATE 関数と DELETE 関数は、フェッチ バッファー内でのみ実行できます。そのとき、ccopt の値が SCROLL_LOCKS または OPTIMISTIC である必要もあります。指定されている値が SCROLL_LOCKS の場合は、操作が成功することが保証されます。指定されている値が OPTIMISTIC の場合は、行が最後にフェッチされてから変更されている場合には操作が失敗します。

指定されている値が OPTIMISTIC の場合に操作が失敗することがあるのは、タイムスタンプかチェックサム値 (SQL Server によって決定されます) を比較することによってオプティミスティック同時実行制御機能が実行されるためです。一致しない行があると操作が失敗します。

戻り値として UPDT_IN_PLACE を指定すると、結果を次のように制御できます。

• 一意インデックスを持つテーブルで位置指定更新を実行するときに UPDT_IN_PLACE を設定しないと、その行がカーソルの作業テーブルから削除されて、カーソルによって使用されているキー列の末尾に挿入されます。その結果、それらの列が変更されます。

• UPDT_IN_PLACE を ON に設定すると、単純に作業テーブルの元の行でキー列が更新されます。

PARAMETERIZED_STMT が指定されている場合は、コード内でのエラー メッセージに従って、パラメーター名を paramdef にする必要があります。PARAMETERIZED_STMT が指定されていない場合は、エラー メッセージで名前は指定されません。

RPC の RETURN_METADATA 入力フラグを 0x0001 に設定すると、カーソル選択リストのメタデータを TDS ストリームで返すように要求できます。

5 番目より後のパラメーターは、入力パラメーターとしてステートメント プランに渡されます。それらのパラメーターのうちの最初のパラメーターは、次の形式の文字列にする必要があります。

{ local variable name data type } [,…n]

後続のパラメーターは、ステートメント内の local variable name の代わりに使用する値を渡すために使用されます。