Share via

  • Article

ServerTraceEventSet Class

The ServerTraceEventSet object represents a set server trace events.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.EventSetBase
    Microsoft.SqlServer.Management.Smo.ServerTraceEventSet

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class ServerTraceEventSet _
    Inherits EventSetBase
'Usage
Dim instance As ServerTraceEventSet

public sealed class ServerTraceEventSet : EventSetBase

public ref class ServerTraceEventSet sealed : public EventSetBase

[<SealedAttribute>]
type ServerTraceEventSet =  
    class
        inherit EventSetBase
    end

public final class ServerTraceEventSet extends EventSetBase

The ServerTraceEventSet type exposes the following members.

Constructors

  Name Description
Public method ServerTraceEventSet() Initializes a new instance of the ServerTraceEventSet class.
Public method ServerTraceEventSet(ServerTraceEvent) Initializes a new instance of the ServerTraceEventSet class with a specified event.
Public method ServerTraceEventSet(array<ServerTraceEvent[]) Initializes a new instance of the ServerTraceEventSet class with the specified set of events.
Public method ServerTraceEventSet(ServerTraceEventSet) Initializes a new instance of the ServerTraceEventSet class with the specified set of events.

Top

Properties

  Name Description
Public property AssemblyLoad Gets or sets a boolean property value that specifies whether the event is included in the event set.
Public property AuditAddDBUserEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property AuditAddloginEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a new login is added.
Public property AuditAddLoginToServerRoleEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a login is added to a server role.
Public property AuditAddMemberToDBRoleEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a new member is added to a database role.
Public property AuditAddRoleEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a new role is added.
Public property AuditAppRoleChangePasswordEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when the password for an application role is changed.
Public property AuditBackupRestoreEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a backup and restore operation is issued.
Public property AuditChangeAuditEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when audit trace modifications are made.
Public property AuditChangeDatabaseOwner Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when the database owner is changed.
Public property AuditDatabaseManagementEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a database is created, altered, or dropped.
Public property AuditDatabaseObjectAccessEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a database object is accessed, such as a schema.
Public property AuditDatabaseObjectGdrEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when grant, deny, or revoke operation is issued on a database object, such as a schema.
Public property AuditDatabaseObjectManagementEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a database object is created, altered or dropped.
Public property AuditDatabaseObjectTakeOwnershipEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when ownership of an object in the database scope is changed.
Public property AuditDatabaseOperationEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a database operation occurs, such as a checkpoint.
Public property AuditDatabasePrincipalImpersonationEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when there is an impersonation within the scope of the database, such as a SETUSER or an EXECUTE AS USER.
Public property AuditDatabasePrincipalManagementEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a principal, such as users, are created, altered, or dropped from the database.
Public property AuditDatabaseScopeGdrEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a grant, deny, or revoke operation is issued within the scope of the database.
Public property AuditDbccEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when DBCC commands are issued.
Public property AuditFulltext Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property AuditLogin Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a user successfully logs on to Microsoft SQL Server.
Public property AuditLoginChangePasswordEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a SQL Server login password is changed.
Public property AuditLoginChangePropertyEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a login property, other than password, is changed.
Public property AuditLoginFailed Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an attempt to log in to SQL Server fails.
Public property AuditLoginGdrEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a grant, deny, or revoke operation is issued on a login object.
Public property AuditLogout Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a user successfully logs out of SQL Server.
Public property AuditSchemaObjectAccessEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an object permission, such as SELECT, is used both successfully or unsuccessfully.
Public property AuditSchemaObjectGdrEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an object grant, deny, or revoke operation is issued.
Public property AuditSchemaObjectManagementEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an object is created, altered or dropped.
Public property AuditSchemaObjectTakeOwnershipEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an ALTER AUTHORIZATION command is used to change the owner of an object.
Public property AuditServerAlterTraceEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a statement checks for the ALTER TRACE permission.
Public property AuditServerObjectGdrEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a grant, deny, or revoke operation is issued on a schema object, such as a table or a function.
Public property AuditServerObjectManagementEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a server objects are created, altered, or dropped.
Public property AuditServerObjectTakeOwnershipEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when the ownership is changed for objects within the scope of the server.
Public property AuditServerOperationEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when Security Audit operations such as altering settings, resources, external access, or authorization are used.
Public property AuditServerPrincipalImpersonationEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when there is an impersonation within scope of the server, such as EXECUTE AS LOGIN.
Public property AuditServerPrincipalManagementEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a server principals are created, altered, or dropped.
Public property AuditServerScopeGdrEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a grant, deny, or revoke operation for permissions is issued in the scope of the server, such as creating a login.
Public property BitmapWarning Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property BlockedProcessReport Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a process has been blocked for more than a specified amount of time.
Public property CpuThresholdExceeded Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property DatabaseMirroringStateChange Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when the state of a mirrored database changes.
Public property DatabaseSuspectDataPage Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property DataFileAutoGrow Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a data file is extended automatically by the server.
Public property DataFileAutoShrink Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a data file is reduced automatically by the server.
Public property DeadlockGraph Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an attempt to acquire a lock is canceled because the attempt was part of a deadlock and was chosen as the deadlock victim.
Public property DeprecationAnnouncement Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a feature is used that will be removed from a future version of SQL Server.
Public property DeprecationFinalSupport Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a feature is used that will be removed from the next major version of SQL Server.
Public property Errorlog Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when error events are logged in the SQL Server error log.
Public property Eventlog Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when error events are logged in the SQL Server application.
Public property Exception Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an exception occurs in SQL Server
Public property ExchangeSpillEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when communication buffers in a parallel query plan have been temporarily written to the tempdb database.
Public property ExecutionWarnings Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when warnings are issued during the execution of a SQL Server statement or stored procedure.
Public property FtCrawlAborted Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an exception is encountered during a full-text crawl.
Public property FtCrawlStarted Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a full-text crawl (population) starts.
Public property FtCrawlStopped Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a full-text crawl (population) starts.
Public property HashWarning Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a hashing operation that is not processing on a buffer partition has reverted to an alternate plan.
Public property LockDeadlock Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when two concurrent transactions have deadlocked each other by trying to obtain incompatible locks on resources that the other transaction owns.
Public property LockDeadlockChain Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs for each of the events leading up to a deadlock.
Public property LockEscalation Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a fine-grained lock has been converted to a coarse-grained lock (for example, a page lock escalated or converted to a table lock).
Public property LogFileAutoGrow Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a log file was extended automatically by the server.
Public property LogFileAutoShrink Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a log file was reduced automatically by the server.
Public property MissingColumnStatistics Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when column statistics that would be useful for the optimizer are not available.
Public property MissingJoinPredicate Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a query that has no join predicate is being executed.
Public property MountTape Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a request to mount a tape is received.
Public property NumberOfElements Gets the number of elements in the event set. (Overrides EventSetBase.NumberOfElements.)
Public property ObjectAltered Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an object is altered.
Public property ObjectCreated Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an object is created.
Public property ObjectDeleted Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an object is deleted.
Public property OledbCallEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property OledbDatareadEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property OledbErrors Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an OLE DB error occurs.
Public property OledbProviderInformation Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property OledbQueryinterfaceEvent Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property Qn_dynamics Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property Qn_parameterTable Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property Qn_subscription Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property Qn_template Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property ServerMemoryChange Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when SQL Server memory usage has increased or decreased by either 1 MB or 5 percent of the maximum server memory, whichever is greater.
Public property ShowplanAllForQueryCompile Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an SQL statement compiles and displays complete, compile-time data.
Public property ShowplanXml Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property ShowplanXmlForQueryCompile Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an SQL statement executes and displays the complete, compile-time data.
Public property ShowplanXmlStatisticsProfile Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property SortWarnings Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a sort warning is generated.
Public property SpCacheinsert Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an item is inserted into the procedure cache.
Public property SpCachemiss Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a procedure is not found in the procedure cache.
Public property SpCacheremove Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when an item is removed from the procedure cache.
Public property SpRecompile Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs when a procedure is recompiled.
Public property SqlStmtrecompile Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Protected property Storage Gets or sets the bit array for event set storage. (Inherited from EventSetBase.)
Public property TraceAllEvents Gets or sets a Boolean property value that specifies whether all events are included in the trace or not.
Public property TraceClr Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property TraceDatabase Gets or sets a Boolean property value that specifies whether the Database category events are recorded in the trace.
Public property TraceDeprecation Gets or sets a Boolean property value that specifies whether Deprecation category events are recorded in the trace.
Public property TraceErrorsAndWarnings Gets or sets a Boolean property value that specifies whether errors and warnings are recorded in the trace.
Public property TraceFileClose Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event occurs if a trace file closes when a transaction is rolled back.
Public property TraceFullText Gets or sets a Boolean property value that specifies whether Full Text category events are recorded in the trace.
Public property TraceLocks Gets or sets a Boolean property value that specifies whether Lock category events are recorded in the trace.
Public property TraceObjects Gets or sets a Boolean property value that specifies whether Object category events are recorded in the trace.
Public property TraceOledb Gets or sets a Boolean property value that specifies whether OLE DB category events are recorded in the trace.
Public property TracePerformance Gets or sets a Boolean property value that specifies whether Performance category events are recorded in the trace.
Public property TraceQueryNotifications Gets or sets a Boolean property value that specifies whether the event is included in the event set.
Public property TraceSecurityAudit Gets or sets a Boolean property value that specifies whether Security Audit category events are recorded in the trace.
Public property TraceServer Gets or sets a Boolean property value that specifies whether Server category events are recorded in the trace.
Public property TraceStoredProcedures Gets or sets a Boolean property value that specifies whether Stored Procedure category events are recorded in the trace.
Public property TraceTsql Gets or sets a Boolean property value that specifies whether Transact-SQL category events are recorded in the trace.
Public property TraceUserConfigurable Gets or sets a Boolean property value that specifies whether Lock category events are recorded in the trace.
Public property Userconfigurable0 Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event is configured by the user.
Public property Userconfigurable1 Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event is configured by the user.
Public property Userconfigurable2 Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event is configured by the user.
Public property Userconfigurable3 Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event is configured by the user.
Public property Userconfigurable4 Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event is configured by the user.
Public property Userconfigurable5 Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event is configured by the user.
Public property Userconfigurable6 Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event is configured by the user.
Public property Userconfigurable7 Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event is configured by the user.
Public property Userconfigurable8 Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event is configured by the user.
Public property Userconfigurable9 Gets or sets a Boolean property value that specifies whether the event is included in the event set. The event is configured by the user.
Public property UserErrorMessage Gets or sets a Boolean value that specifies whether the UserErrorMessage event is included in the event set.
Public property XqueryStaticType Gets or sets a Boolean property value that specifies whether the event is included in the event set.

Top

Methods

  Name Description
Public method Add(ServerTraceEvent) Returns a trace event set after adding a trace event to an existing event set.
Public methodStatic member Add(ServerTraceEventSet, ServerTraceEvent) Returns a trace event set after adding a trace event to an existing event set.
Public method Copy Returns a copy of the event set. (Overrides EventSetBase.Copy().)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method FitsMask Specifies whether the EventSetBase object fits the specified mask. (Inherited from EventSetBase.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method HasCommonBits Specifies whether the EventSetBase object has common bits with another specified EventSetBase object. (Inherited from EventSetBase.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Remove Removes an event from the event set.
Protected method SetValue Sets the bit value at the specified index position. (Inherited from EventSetBase.)
Public methodStatic member Subtract Returns a trace event set after subtracting a trace event from an existing event set.
Public method ToString Returns a string that represents the ServerTraceEventSet object. (Overrides Object.ToString().)

Top

Operators

  Name Description
Public operatorStatic member Addition Creates a server trace event set by performing an addition operation on a ServerTraceEvent object and a ServerTraceEventSet object.
Public operatorStatic member Subtraction Creates a server trace event set by performing a subtraction operation on a ServerTraceEvent object and a ServerTraceEventSet object.

Top

Remarks

The ServerTraceEventSet object contains a property for each event to which the server trace responds. The events fall into categories, which are described in SQL Server Event Class Reference. The ServerTraceEventSet class is used to define a set of events that can be traced by SQL Server Profiler or the SMO Trace objects.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.