Session 类

Represents a row in sys.server_event_sessions and includes data from sys.dm_xe_sessions if running.

继承层次结构

System.Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
    Microsoft.SqlServer.Management.XEvent.Session

命名空间：  Microsoft.SqlServer.Management.XEvent
程序集：  Microsoft.SqlServer.Management.XEvent（在 Microsoft.SqlServer.Management.XEvent.dll 中）

语法

声明
Public NotInheritable Class Session _
    Inherits SfcInstance _
    Implements ISfcCreatable, ICreatable, ISfcAlterable, IAlterable,  _
    ISfcDroppable, IDroppable, ISfcValidate, ISfcDiscoverObject
用法
Dim instance As Session

public sealed class Session : SfcInstance, 
    ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, ISfcDroppable, 
    IDroppable, ISfcValidate, ISfcDiscoverObject

public ref class Session sealed : public SfcInstance, 
    ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, ISfcDroppable, 
    IDroppable, ISfcValidate, ISfcDiscoverObject

[<SealedAttribute>]
type Session =  
    class 
        inherit SfcInstance 
        interface ISfcCreatable 
        interface ICreatable 
        interface ISfcAlterable 
        interface IAlterable 
        interface ISfcDroppable 
        interface IDroppable 
        interface ISfcValidate 
        interface ISfcDiscoverObject 
    end

public final class Session extends SfcInstance implements ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, ISfcDroppable, IDroppable, ISfcValidate, ISfcDiscoverObject

Session 类型公开以下成员。

构造函数

	名称	说明
	Session()	Initializes a new instance of Session class.
	Session(XEStore, String)	Initializes a new instance of Session class.

页首

属性

	名称	说明
	AbstractIdentityKey	不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	AutoStart	Gets or sets a value indicating whether the AutoStart object is active or not.
	EventRetentionMode	Gets or sets the EventRetentionMode object.
	Events	Gets the EventCollection of the session.
	ID	Gets the ID object.
	IdentityKey	Gets the identity key of the session.
	IsRunning	Gets a value indicating whether this session is running.
	MaxDispatchLatency	Gets or sets the maximum dispatch latency in seconds.
	MaxEventSize	Gets or sets the size in KB of the maximum event for the session.
	MaxMemory	Gets or sets the maximum memory in KB of the session.
	MemoryPartitionMode	Gets or sets the memory partition mode from an enumeration with options for perNode, perCpu, or none.
	Metadata	Returns metadata about the instance and its domain. （从 SfcInstance 继承。）
	Name	Gets the name of the Session object.
	Parent	Gets or sets the parent XEStore object.
	Properties	Returns a collection instance properties. （从 SfcInstance 继承。）
	StartTime	Gets the start time.
	State	Gets the state of the object used in Alter function in session.
	Targets	Gets the TargetCollection.
	TrackCausality	Gets or sets a Boolean value indicating whether the TrackCausality object is activated.
	Urn	Returns the uniform resource name of the SfcInstance object. （从 SfcInstance 继承。）

页首

方法

	名称	说明
	AddEvent(String)	Adds a new Event object to the session from fully qualified event name.
	AddEvent(EventInfo)	Adds a new Event object to the session.
	AddTarget(String)	Adds a new Target object to the session.
	AddTarget(TargetInfo)	Adds a new Target object to the session.
	Alter	Alters the Session object on the server.
	Create	Creates the Session object on the server.
	CreateIdentityKey	不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	Discover	不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	Drop	Drops the Session object on the server.
	Equals	（从 Object 继承。）
	GetChildCollection	不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	GetDomain	不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	GetHashCode	（从 Object 继承。）
	GetObjectFactory	Gets the SQL Foundation Class object factory.
	GetPropertySet	Returns the set of properties for the SfcInstance object. （从 SfcInstance 继承。）
	GetType	（从 Object 继承。）
	GetTypeMetadataImpl	Indicates the domains that override by returning the right TypeMetadata class directly. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	InitializeUIPropertyState	不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	OnPropertyMetadataChanges	Invoked whenever the effective value of any SfcInstance metadata is updated. （从 SfcInstance 继承。）
	OnPropertyValueChanges	Invoked whenever the effective value of any SfcInstance property is updated. （从 SfcInstance 继承。）
	Refresh	Refreshes the object's properties by reading them from the server. （从 SfcInstance 继承。）
	RemoveEvent	Removes the specified Event object from the session.
	RemoveTarget	Removes the Target object from the session.
	ResetKey	不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	ScriptAlter	Gets the alteration ISfcScript for the session.
	ScriptCreate	Gets the creation ISfcScript for the session.
	ScriptDrop	Gets the drop ISfcScript for the session.
	Serialize	Serializes the instance to XML. （从 SfcInstance 继承。）
	Start	Starts the Session object.
	Stop	Stops the Session object.
	ToString	Returns a string representation of the instance Urn. （从 SfcInstance 继承。）
	Validate(String)	Validates the specified method name.
	Validate(String, array<Object[])	Validates the method specified by the name parameter.

页首

事件

	名称	说明
	PropertyChanged	CLS-compliant event for property changes. （从 SfcInstance 继承。）
	PropertyMetadataChanged	CLS-compliant event for property metadata changes. （从 SfcInstance 继承。）

页首

字段

	名称	说明
	DefaultDispatchLatency	Default dispatch latency is 30 seconds.
	DefaultMaxMemory	The maximum amount of memory by default is 4 MB.
	InfiniteDispatchLatency	0 indicates that dispatch latency is infinite.
	NotStarted	Session is currently not running.

页首

显式接口实现

	名称	说明
	ISfcDiscoverObject.Discover	Discovers or alters dependency actions and events in the Session object.

页首

注释

The Session object is the main object that user code interacts with.

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.SqlServer.Management.XEvent 命名空间