Creates and populates a cursor based upon the execution plan created by sp_cursorprepare. This procedure, coupled with sp_cursorprepare, has the same function as sp_cursoropen, but is split into two phases. sp_cursorexecute is invoked by specifying ID =4 in a tabular data stream (TDS) packet.
|Applies to: SQL Server (SQL Server 2008 through current version).|
sp_cursorexecute prepared_handle, cursor [ , scrollopt[ OUTPUT ] [ , ccopt[ OUTPUT ] [ ,rowcount OUTPUT [ ,bound param][,...n]]]]]
Is the prepared statement handle value returned by sp_cursorprepare. prepared_handle is a required parameter that calls for an int input value.
Is the SQL Server-generated cursor identifier. cursor is a required parameter that must be supplied on all subsequent procedures which act upon the cursor, such as sp_cursorfetch
Scroll option. scrollopt is an optional parameter that requires an int input value. The sp_cursorexecutescrollopt parameter has the same value options as those for sp_cursoropen.
Currency control option. ccopt is an optional parameter that requires an int input value. The sp_cursorexecuteccopt parameter has the same value options as those for sp_cursoropen.
Is an optional parameter that signifies the number of fetch buffer rows to use with AUTO_FETCH. The default is 20 rows. rowcount behaves differently when assigned as an input value versus a return value.
|As input value||As return value|
|When AUTO_FETCH is specified with FAST_FORWARD cursors rowcount represents the number of rows to place into the fetch buffer.||Represents the number of rows in the result set. When the scrollopt AUTO_FETCH value is specified, rowcount returns the number of rows that were fetched into the fetch buffer.|
Signifies the optional use of additional parameters.
rowcount may return the following values.
|-1||Number of rows unknown.|
|-n||An asynchronous population is in effect.|
scrollopt and ccopt are useful when the cached plans are preempted for the server cache, meaning that the prepared handle identifying the statement must be recompiled. The scrollopt and ccopt parameter values must match the values sent in the original request to sp_cursorprepare.
Failure to provide matching values will result in recompilation of the plans, negating the prepare and execute operations.
The RPC RETURN_METADATA input flag can be set to 1 to request that cursor select list metadata be returned in the TDS stream.