Microsoft.SqlServer.Management.XEvent Namespace
The common object model for creating and using SQL Server Extended Events in client and server components of SQL Server. The Extended Events infrastructure supports the correlation of data from SQL Server events. Under certain circumstances, the infrastructure can also be used to correlated data from the operating system and database applications.
| Class | Description | |
|---|---|---|
![]() | Action | The runtime class for the Action class. Each instance of this class represents a row in sys.server_event_session_actions. |
![]() | ActionCollection | Represents SQL Server Foundation classes (SFC) collection of Action objects. |
![]() | ActionInfo | Represents metadata for an Action object. |
![]() | ActionInfoCollection | Represents the SQL Server Foundation Class collection for the ActionInfo class. |
![]() | BaseXEStore | The BaseXEStore class is the base class for all metadata classes and runtime classes. |
![]() | DataEventColumnInfo | Represents a data column of an EventInfo object. |
![]() | DataEventColumnInfoCollection | Represents a collection of DataEventColumnInfo objects. |
![]() | Event | Represents the runtime class for T:Microsoft.SqlServer.Management.XEvent objects. Each instance of this class represents a row in sys.server_event_session_events. |
![]() | EventCollection | Represents SQL Server Foundation classes (SFC) collection class of T:Microsoft.SqlServer.Management.XEvent objects. |
![]() | EventColumnInfo | Represents a customizable column of an T:Microsoft.SqlServer.XEvent.EventInfo object. |
![]() | EventColumnInfoCollection | Represents a collection of EventColumnInfo objects. |
![]() | EventField | Represents a row insys.server_event_session_fields. |
![]() | EventFieldCollection | Represents a collection class for EventField objects. |
![]() | EventInfo | Metadata class for the T:Microsoft.SqlServer.Management.XEvent class and the parent class for EventColumnInfo objects. |
![]() | EventInfoCollection | SQL Server Foundation Class collection class for EventInfo objects. |
![]() | Action::Key | Represents the SQL Foundation Class key class used for identification of an Action object. |
![]() | ActionInfo::Key | Represents the key class for identification of an ActionInfo object. |
![]() | BaseXEStore::Key | Represents the identity key for a BaseXEStore object. |
![]() | DataEventColumnInfo::Key | The identity key of the column associated with this DataEventColumnInfo. |
![]() | Event::Key | Represents an SfcKey class for identification of an Event. |
![]() | EventColumnInfo::Key | Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. |
![]() | EventField::Key | Represents the identity key for an EventField object. |
![]() | EventInfo::Key | Represents an SQL Foundation Class key class that identifies an EventInfo object. |
![]() | MapInfo::Key | Represents the identity key for a MapInfo::Key object. |
![]() | MapValueInfo::Key | Represents an internal key for the MapValueInfo class. |
![]() | Package::Key | Represents an SQL Foundation Class key that identifies a Package object. |
![]() | PredCompareInfo::Key | Represents an SQL Foundation Class key for identification of PredCompareInfo objects. |
![]() | PredSourceInfo::Key | A SQL Foundation Class key for identification of PredSourceInfo objects. |
![]() | ReadOnlyEventColumnInfo::Key | Represents an SQL Foundation Class key for identification of ReadOnlyEventColumnInfo objects. |
![]() | Session::Key | Represents an internal identity key class for Session class. |
![]() | Target::Key | Represents a key class for identification of Target objects. |
![]() | TargetColumnInfo::Key | An identity key class for TargetColumnInfo objects. |
![]() | TargetField::Key | Represents a key class for identification of TargetField objects. |
![]() | TargetInfo::Key | Represents the identity key for a TargetInfo object. |
![]() | TypeInfo::Key | Represents an SfcKey class for identification of TargetInfo objects. |
![]() | MapInfo | Represents a metadata for MapInfo class. |
![]() | MapInfoCollection | Collection class for MapInfo objects. |
![]() | MapValueInfo | Represents a record in sys.dm_xe_map_values. |
![]() | MapValueInfoCollection | Collection class for MapValueInfo objects. |
![]() | BaseXEStore::ObjectMetadata | Provides methods used to access information about the XEvent object. |
![]() | Package | Metadata for other information classes such as EventInfo, TargetInfo, ActionInfo, and others listed in Remarks. |
![]() | PackageCollection | Represents the SQL Foundation Class collection for Package objects. |
![]() | PredCompareExpr | Represents a predicate expression that can be used in a conditional statement. |
![]() | PredCompareInfo | Represents a metadata class for T:Microsoft.SqlServer.Management.XEvent.PredCompare objects. |
![]() | PredCompareInfoCollection | Sql Foundation Class collection for PredCompareInfo objects. |
![]() | PredExpr | Represents the abstract base class for the PredCompareExpr class. |
![]() | PredFunctionExpr | Represents the function expression in a predicate. |
![]() | Predicate | Represents the abstract base class for all predicate classes. |
![]() | PredLogicalExpr | Represents a predicate that can be used in an expression. |
![]() | PredOperand | Represents a predicate operand. A predicate operand can be a DataEventColumnInfo object or a PredSourceInfo object. |
![]() | PredSourceInfo | Represents pred_sourceobjects insys.dm_xe_objects. |
![]() | PredSourceInfoCollection | Represents the collection class for PredSourceInfo objects. |
![]() | PredValue | Represents an rvalue in PredCompareExpr object or the second parameter in the PredFunctionExpr object. |
![]() | ReadOnlyEventColumnInfo | Represents a readonly column of an EventInfo object. |
![]() | ReadOnlyEventColumnInfoCollection | Represents a collection class for ReadOnlyEventColumnInfo objects. |
![]() | XEStore::ServerKey | Represents the identity for a XEStore object. |
![]() | Session | Represents a row in sys.server_event_sessions and includes data from sys.dm_xe_sessions if running. |
![]() | SessionCollection | Represents the collection for Session objects. |
![]() | SessionProviderBase | Represents the session provider base. |
![]() | Target | Represents the runtime class for Target objects. Each instance of this class represents a row in sys.server_event_session_targets. |
![]() | TargetCollection | Represents SQL Server Foundation Class collection for Target objects. |
![]() | TargetColumnInfo | Represents a customizable column of a TargetInfo object. |
![]() | TargetColumnInfoCollection | SQL Foundation Class collection for the TargetColumnInfo class. |
![]() | TargetField | Represents a row in sys.server_event_session_fields. |
![]() | TargetFieldCollection | SQL Foundation Class collection for TargetField objects. |
![]() | TargetInfo | Represents target objects in sys.dm_xe_objects. |
![]() | TargetInfoCollection | Represents a collection class for TargetInfo objects. |
![]() | TypeInfo | Represents type objects in sys.dm_xe_objects. |
![]() | TypeInfoCollection | Represents the collection class for TypeInfo objects. |
![]() | XEStore | Represents the XEStore class is the base class for all metadata classes and runtime classes. |
![]() | XEUtils | Provides helper methods for scripting. |
![]() | XEventException | Base exception class for all XEventException classes. |
| Interface | Description | |
|---|---|---|
![]() | IEventProvider | defines the interface that component providers need to implement for the Event, the Runtime class for the Events. |
![]() | ISessionObject | Defines the interface that the objects need to implement for the session. |
![]() | ISessionProvider | defines the interface that component providers need to implement for the Session, the main object user code interacts with. |
![]() | ITargetProvider | defines the interface that component providers need to implement for the Target, the Runtime class for Target |
![]() | IXEObjectInfo | Provides interface for the child objects of Package. |
![]() | IXEStoreProvider | Defines the interface that component providers need to implement for the XEStore, which is the root for all metadata classes and runtime classes. |
| Enumeration | Description | |
|---|---|---|
![]() | PredCompareExpr::ComparatorType | Defines the comparator that is used between a PredOperand object and PredValue object in a PredCompareExpr object. |
![]() | Session::EventRetentionModeEnum | Event retention mode enumeration describes how event loss is handled. |
![]() | PredLogicalExpr::LogicalOperatorType | Represents an enumeration of the logical operator types: AND, OR, NOT. |
![]() | Session::MemoryPartitionModeEnum | Memory partition mode enumeration that describes the location in memory where event buffers are created. |


