Share via

Microsoft.SqlServer.Management.XEvent Namespace

  • Article

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.

Classes

  Class Description
Public class Action The runtime class for the Action class. Each instance of this class represents a row in sys.server_event_session_actions.
Public class Action.Key Represents the SQL Foundation Class key class used for identification of an Action object.
Public class ActionCollection Represents SQL Server Foundation classes (SFC) collection of Action objects.
Public class ActionInfo Represents metadata for an Action object.
Public class ActionInfo.Key Represents the key class for identification of an ActionInfo object.
Public class ActionInfoCollection Represents the SQL Server Foundation Class collection for the ActionInfo class.
Public class DataEventColumnInfo Represents a data column of an EventInfo object.
Public class DataEventColumnInfo.Key The identity key of the column associated with this DataEventColumnInfo.
Public class DataEventColumnInfoCollection Represents a collection of DataEventColumnInfo objects.
Public class Event Represents the runtime class for XEvent objects. Each instance of this class represents a row in sys.server_event_session_events.
Public class Event.Key An SfcKey class for identification of an Event.
Public class EventCollection SQL Server Foundation classes (SFC) collection class of XEvent objects.
Public class EventColumnInfo Represents a customizable column of an EventInfo object.
Public class EventColumnInfo.Key Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.
Public class EventColumnInfoCollection Represents a collection of EventColumnInfo objects.
Public class EventField Represents a row in sys.server_event_session_fields.
Public class EventField.Key Represents the identity key for an EventField object.
Public class EventFieldCollection Represents a collection class for EventField objects.
Public class EventInfo Metadata class for the XEvent class and the parent class for EventColumnInfo objects.
Public class EventInfo.Key SQL Foundation Class key class that identifies an EventInfo object.
Public class EventInfoCollection SQL Server Foundation Class collection class for EventInfo objects.
Public class MapInfo Metadata for MapInfo class.
Public class MapInfo.Key Represents the identity key for a MapInfo.Key object.
Public class MapInfoCollection Collection class for MapInfo objects.
Public class MapValueInfo Represents a record in sys.dm_xe_map_values.
Public class MapValueInfo.Key Internal key for the MapValueInfo class.
Public class MapValueInfoCollection Collection class for MapValueInfo objects.
Public class Package Metadata for other information classes such as EventInfo, TargetInfo, ActionInfo, and others listed in Remarks.
Public class Package.Key A SQL Foundation Class key that identifies a Package object.
Public class PackageCollection Represents the SQL Foundation Class collection for Package objects.
Public class PredCompareExpr Represents a predicate expression that can be used in a conditional statement.
Public class PredCompareInfo Metadata class for PredCompare objects.
Public class PredCompareInfo.Key An SQL Foundation Class key for identification of PredCompareInfo objects.
Public class PredCompareInfoCollection Sql Foundation Class collection for PredCompareInfo objects.
Public class PredExpr Represents the abstract base class for the PredCompareExpr class.
Public class PredFunctionExpr Represents the function expression in a predicate.
Public class Predicate Represents the abstract base class for all predicate classes.
Public class PredLogicalExpr Represents a predicate that can be used in an expression.
Public class PredOperand Represents a predicate operand. A predicate operand can be a DataEventColumnInfo object or a PredSourceInfo object.
Public class PredSourceInfo Represents pred_source objects in sys.dm_xe_objects.
Public class PredSourceInfo.Key A SQL Foundation Class key for identification of PredSourceInfo objects.
Public class PredSourceInfoCollection Represents the collection class for PredSourceInfo objects.
Public class PredValue Represents an rvalue in PredCompareExpr object or the second parameter in the PredFunctionExpr object.
Public class ReadOnlyEventColumnInfo Represents a readonly column of an EventInfo object.
Public class ReadOnlyEventColumnInfo.Key A SQL Foundation Class key for identification of ReadOnlyEventColumnInfo objects.
Public class ReadOnlyEventColumnInfoCollection Represents a collection class for ReadOnlyEventColumnInfo objects.
Public class Session Represents a row in sys.server_event_sessions and includes data from sys.dm_xe_sessions if running.
Public class Session.Key Internal identity key class for Session class.
Public class SessionCollection Represents the collection for Session objects.
Public class Target Represents the runtime class for Target objects. Each instance of this class represents a row in sys.server_event_session_targets.
Public class Target.Key A key class for identification of Target objects.
Public class TargetCollection SQL Server Foundation Class collection for Target objects.
Public class TargetColumnInfo Represents a customizable column of a TargetInfo object.
Public class TargetColumnInfo.Key An identity key class for TargetColumnInfo objects.
Public class TargetColumnInfoCollection SQL Foundation Class collection for the TargetColumnInfo class.
Public class TargetField Represents a row in sys.server_event_session_fields.
Public class TargetField.Key A key class for identification of TargetField objects.
Public class TargetFieldCollection SQL Foundation Class collection for TargetField objects.
Public class TargetInfo Represents target objects in sys.dm_xe_objects.
Public class TargetInfo.Key Represents the identity key for a TargetInfo object.
Public class TargetInfoCollection Represents a collection class for TargetInfo objects.
Public class TypeInfo Represents type objects in sys.dm_xe_objects.
Public class TypeInfo.Key An SfcKey class for identification of TargetInfo objects.
Public class TypeInfoCollection Represents the collection class for TypeInfo objects.
Public class XEStore The XEStore class is the base class for all metadata classes and runtime classes.
Public class XEStore.Key Represents an SfcKey class.
Public class XEStore.ObjectMetadata Provides helper methods over the metadata hierarchy objects.
Public class XEventException Base exception class for all XEventException classes.

Interfaces

  Interface Description
Public interface IXEObjectInfo Provides interface for the child objects of Package.

Enumerations

  Enumeration Description
Public enumeration PredCompareExpr.ComparatorType Defines the comparator that is used between a PredOperand object and PredValue object in a PredCompareExpr object.
Public enumeration PredLogicalExpr.LogicalOperatorType Represents an enumeration of the logical operator types: AND, OR, NOT.
Public enumeration Session.EventRetentionModeEnum Event retention mode enumeration describes how event loss is handled.
Public enumeration Session.MemoryPartitionModeEnum Memory partition mode enumeration that describes the location in memory where event buffers are created.