Microsoft.SqlServer.Management.XEvent Namespace

Classes

Action

RunTime class for Action. Each instance of this class represents a row in sys.server_event_session_actions.

Action.Key

A key class for identification.

ActionCollection

SFC Collection class for Action.

ActionInfo

Metadata for Action.

ActionInfo.Key

A key class for identification.

ActionInfoCollection

SFC Collection class for ActionInfo.

BaseXEStore

XEStore is the root for all metadata classes and runtime classes.

BaseXEStore.Key
BaseXEStore.ObjectMetadata

Provides helpers methods over the metadata hierarchy objects

DataEventColumnInfo

An EventInfo object may have three kinds of columns: customizable, data, readonly. A DataEventColumnInfo object reprensents a data column of an EventInfo object and can be used in PredOperand.

DataEventColumnInfo.Key
DataEventColumnInfoCollection

This is collection class for DataEventColumnInfo.

Event

Runtime class for Event. Each instance of this class represents a row in sys.server_event_session_events.

Event.Key

A key class for identification.

EventCollection

SFC Collection class for Event.

EventColumnInfo

An EventInfo object may have three kinds of columns: customizable, data, readonly. An EventColumnInfo object reprensents a customizable column of an EventInfo object.

EventColumnInfo.Key
EventColumnInfoCollection

This is collection class for EventColumnInfo.

EventField

An EventField object reprensents a row in sys.server_event_session_fields.

EventField.Key
EventFieldCollection

This is collection class for EventField.

EventInfo

Metadata class for Event.

EventInfo.Key

A key class for identification.

EventInfoCollection

SFC Collection class for EventInfo.

MapInfo

Metadata class for Map

MapInfo.Key

A key class for identification.

MapInfoCollection

SFC Collection class for MapInfo.

MapValueInfo

MapValueInfo class represents a record in sys.dm_xe_map_values.

MapValueInfo.Key

Internal used Key class

MapValueInfoCollection

This is collection class for MapValueInfo.

Package

Metadata class for Package.

Package.Key

A key class for identification.

PackageCollection

SFC Collection class for Package

PredCompareExpr

PredCompareExpr class represents expression like sqlserver.database_id=7

PredCompareInfo

Metadata class for Pred_Compare

PredCompareInfo.Key

A key class for identification.

PredCompareInfoCollection

SFC Collection class for PredCompareInfo.

PredExpr

Base class for all of the predicate expression.

PredFunctionExpr

Class for the function expression in a predicate. A function expression is like this: Pred_Compare(operand, value) where operand is an instance of PredOperand and value is an instance of PredValue.

Predicate

Predicate is the base class of all predicate related classes.

PredLogicalExpr

PredLogicalExpr class can apply NOT on one PredExpr or AND/OR on two PredExprs

PredOperand

Class for predicate operand. A predicate operand can be an event column or a pred_source.

PredSourceInfo

PredSourceInfo class represents pred_source objects in sys.dm_xe_objects.

PredSourceInfo.Key

Internal used Key class

PredSourceInfoCollection

This is collection class for PredSourceInfo.

PredValue

PredValue represents is rvalue in PredCompareExpr or second parameter in PredFunctionExpr

ReadOnlyEventColumnInfo

An EventInfo object may have three kinds of columns: customizable, data, readonly. A ReadOnlyEventColumnInfo object reprensents a readonly column of an EventInfo object.

ReadOnlyEventColumnInfo.Key
ReadOnlyEventColumnInfoCollection

This is collection class for ReadOnlyEventColumnInfo.

Session

Session is the main object user code interacts with. A Session object represents a row in sys.server_event_sessions and also includes some data from sys.dm_xe_sessions if it's started.

Session.Key

Internal used Key class

SessionCollection

This is the collection for Sessions.

SessionProviderBase

Sql provider for Session.

Target

Runtime class for Target. Each instance of this class represents a row in sys.server_event_session_targets.

Target.Key

A key class for identification.

TargetCollection

SFC Collection class for Target.

TargetColumnInfo

TargetInfo currently has only one kind of column: customizable column. A TargetColumnInfo object reprensents a customizable column of a TargetInfo object.

TargetColumnInfo.Key

A key class for identification.

TargetColumnInfoCollection

SFC Collection class for TargetColumnInfo.

TargetField

A TargetField object reprensents a row in sys.server_event_session_fields.

TargetField.Key

A key class for identification.

TargetFieldCollection

SFC Collection class for TargetField.

TargetInfo

TargetInfo class represents target objects in sys.dm_xe_objects.

TargetInfo.Key

Internal used Key class

TargetInfoCollection

This is the collection for TargetInfo objects.

TypeInfo

TypeInfo class represents type objects in sys.dm_xe_objects.

TypeInfo.Key

Internal used Key class

TypeInfoCollection

This is collection class for TypeInfo.

XEStore

XEStore is the root for all metadata classes and runtime classes.

XEStore.ServerKey
XEUtils

Provides helper methods for scripting.

XEventException

Base exception class for all XEvent exception classes

Interfaces

IEventProvider

defines the interface that component providers need to implement for the Event, the Runtime class for the Events.

ISessionObject

common interface part of Events and Targets

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

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.

Enums

PredCompareExpr.ComparatorType

Define what comparator could be used between PredOperand and PredValue

PredLogicalExpr.LogicalOperatorType

Define logical operator that could be used in PredLogicalExpr

Session.EventRetentionModeEnum

Event retention mode describes how event loss is handled.

Session.MemoryPartitionModeEnum

Memory partition mode describes the location in memory where event buffers are created.