Edit

CursorPrepare Event Class

  • Article

Applies to: SQL Server Azure SQL Database Azure SQL Managed Instance

The CursorPrepare event class describes cursor prepare events that occur in application programming interface (API) cursors. Cursor prepare events occur when the Microsoft Database Engine compiles a SELECT statement associated with a cursor into an execution plan but does not create the cursor.

Include the CursorPrepare event class in traces that are recording the performance of cursors. When the CursorPrepare event class is included in a trace, the amount of overhead incurred will depend on how frequently cursors are used against the database during the trace. If cursors are used extensively, the trace may significantly impede performance.

CursorPrepare Event Class Data Columns

Data column name Data type Description Column ID Filterable
ApplicationName nvarchar Name of the client application that created the connection to an instance of SQL Server. This column is populated with the values passed by the application rather than the displayed name of the program. 10 Yes
ClientProcessID int ID assigned by the host computer to the process where the client application is running. This data column is populated if the client process ID is provided by the client. 9 Yes
DatabaseID int ID of the database specified by the USE database statement or the default database if no USE database statement has been issued for a given instance. SQL Server Profiler displays the name of the database if the ServerName data column is captured in the trace and the server is available. Determine the value for a database by using the DB_ID function. 3 Yes
DatabaseName nvarchar Name of the database in which the user statement is running. 35 Yes
EventClass int Type of event recorded = 70. 27 No
EventSequence int Sequence of CursorPrepare event class in batch. 51 No
GroupID int ID of the workload group where the SQL Trace event fires. 66 Yes
Handle int Handle of the event class. 33 Yes
HostName nvarchar Name of the computer on which the client is running. This data column is populated if the host name is provided by the client. To determine the host name, use the HOST_NAME function. 8 Yes
IsSystem int Indicates whether the event occurred on a system process or a user process. 1 = system, 0 = user. 60 Yes
LoginName nvarchar Name of the login of the user (either SQL Server security login or the Windows login credentials in the form of DOMAIN\username). 11 Yes
LoginSid image Security identification number (SID) of the logged-in user. You can find this information in the sys.server_principals catalog view. Each SID is unique for each login in the server. 41 Yes
NTDomainName nvarchar Windows domain to which the user belongs. 7 No
NTUserName nvarchar Windows user name. 6 Yes
RequestID int Request identification that prepared the cursor. 49 Yes
ServerName nvarchar Name of the instance of SQL Server being traced. 26 No
SessionLoginName nvarchar Login name of the user who originated the session. For example, if you connect to SQL Server using Login1 and execute a statement as Login2, SessionLoginName shows Login1 and LoginName shows Login2. This column displays both SQL Server and Windows logins. 64 Yes
SPID int ID of the session on which the event occurred. 12 Yes
StartTime datetime Time at which the event started, when available. 14 Yes
TransactionID bigint System-assigned ID of the transaction. 4 Yes
XactSequence bigint Token used to describe the current transaction. 50 Yes

See Also

Extended Events
sp_trace_setevent (Transact-SQL)
Cursors