Session 类

定义

命名空间:: Microsoft.SqlServer.Management.XEvent

程序集:: Microsoft.SqlServer.Management.XEvent.dll

包:: Microsoft.SqlServer.SqlManagementObjects v150.18208.0

包:: Microsoft.SqlServer.SqlManagementObjects v160.2004021.0

包:: Microsoft.SqlServer.SqlManagementObjects v172.64.0

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。

public sealed class Session : Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.ICreatable, Microsoft.SqlServer.Management.Common.IDroppable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcAlterable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcCreatable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcDroppable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcValidate

type Session = class
    inherit SfcInstance
    interface ISfcCreatable
    interface ICreatable
    interface ISfcAlterable
    interface IAlterable
    interface ISfcDroppable
    interface IDroppable
    interface ISfcValidate
    interface ISfcDiscoverObject

Public NotInheritable Class Session
Inherits SfcInstance
Implements IAlterable, ICreatable, IDroppable, ISfcAlterable, ISfcCreatable, ISfcDroppable, ISfcValidate

继承: Object

SfcInstance
Session

实现: IAlterable ICreatable IDroppable ISfcAlterable ISfcCreatable ISfcDiscoverObject ISfcDroppable ISfcValidate

构造函数

名称	说明
Session()	默认构造函数
Session(BaseXEStore, String)	最常用的构造函数

字段

名称	说明
AutoStartProperty	自动启动
DefaultDispatchLatency	默认调度延迟为 30 秒。
DefaultMaxMemory	默认情况下，最大模因数为 4 MB。
EventRetentionModeProperty	EventRetentionMode
InfiniteDispatchLatency	0 表示调度延迟是无限的。
MaxDispatchLatencyProperty	MaxDispatchLatency
MaxEventSizeProperty	MaxEventSize
MaxMemoryProperty	MaxMemory
MemoryPartitionModeProperty	MemoryPartitionMode
NotStarted	会话当前未运行。
TrackCausalityProperty	TrackCausality
TypeTypeName	类型名称

属性

名称	说明
AbstractIdentityKey	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
AutoStart	获取或设置一个值，该值指示 [自动启动]。
EventRetentionMode	获取或设置事件保留模式。
Events	获取事件集合。
ID	获取 ID。
IdentityKey	获取标识密钥。
IsRunning	获取一个值，该值指示此会话是否正在运行。
KeyChain	返回对象的标识路径 (继承自 SfcInstance)
MaxDispatchLatency	获取或设置最大调度延迟（以秒为单位）。
MaxEventSize	获取或设置最大事件的大小（以 KB 为单位）。
MaxMemory	获取或设置最大内存（以 KB 为单位）。
MemoryPartitionMode	获取或设置内存分区模式。
Metadata	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
Name	会话的名称
Parent	获取或设置父级。
Properties	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
PropertyStorageProvider	此属性返回 ISfcPropertyStorageProvider 接口的默认实现，可以在子类中重写它以返回另一个存储提供程序（即平面属性列表） (继承自 SfcInstance)
StartTime	获取开始时间。
State	在会话中的 Alter 函数中使用的对象状态。
Targets	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。
TrackCausality	获取或设置一个值，该值指示 [跟踪因果关系]。
Urn	在每个请求上创建新的 Urn 字符串并返回它。 (继承自 SfcInstance)

方法

名称	说明
AddEvent(EventInfo)	新建事件并将其添加到此会话。
AddEvent(String)	从完全限定的事件名称中新建一个事件，并将其添加到此会话。
AddTarget(String)	从完全限定的目标名称中新建一个目标，并将其添加到此会话。
AddTarget(TargetInfo)	新建目标并将其添加到此会话。
Alter()	更改后端服务器中的会话。
AlterImpl()	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
CheckObjectCreated()	当 API 要求对象的创建比 CheckObjectState 更强时从域调用 (继承自 SfcInstance)
CheckObjectState()	从域中调用以访问对象 (继承自 SfcInstance)
Create()	在后端服务器中创建会话。
CreateIdentityKey()	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
CreateImpl()	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
Discover(ISfcDependencyDiscoveryObjectSink)	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
Drop()	在后端服务器中删除会话。
DropImpl()	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
GetChildCollection(String)	获取此实例中给定元素名称字符串的子集合。 (继承自 SfcInstance)
GetDomain()	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
GetObjectFactory()	获取对象工厂。
GetPropertySet()	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
GetTypeMetadataImpl()	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
InitializeUIPropertyState()	可重写那些关心初始化其状态的子对象（当前为“动态元数据”。Enabled“ 属性） (继承自 SfcInstance)
MarkForDropImpl(Boolean)	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
MarkRootAsConnected()	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
MoveImpl(SfcInstance)	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs)	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
OnPropertyValueChanges(PropertyChangedEventArgs)	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
PostAlter(Object)	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
PostCreate(Object)	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
PostDrop(Object)	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
PostMove(Object)	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
PostRename(Object)	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
Refresh()	通过从服务器读取对象属性来刷新这些属性 (继承自 SfcInstance)
RemoveEvent(Event)	从会话中删除事件对象。
RemoveTarget(Target)	从此会话中删除目标对象。
RenameImpl(SfcKey)	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
ResetKey()	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
ScriptAlter()	此会话的脚本更改。
ScriptCreate()	为此会话创建脚本。
ScriptDrop()	此会话的脚本删除
Serialize(XmlWriter)	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
Start()	启动此会话。
Stop()	停止此会话。
ToString()	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
UpdateUIPropertyState()	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
Validate()	基本子对象的验证 (继承自 SfcInstance)
Validate(String, Object[])	验证指定的方法名称。
Validate(String)	验证指定的方法名称。

活动

名称	说明
propertyChanged	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
PropertyChanged	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
propertyMetadataChanged	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)
PropertyMetadataChanged	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。 (继承自 SfcInstance)

显式接口实现

名称	说明
ISfcDiscoverObject.Discover(ISfcDependencyDiscoveryObjectSink)	会话是与之交互的主要对象用户代码。 Session 对象表示sys.server_event_sessions中的一行，并在启动时包含来自sys.dm_xe_sessions的某些数据。

适用于