Session Class

 

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

Namespace:   Microsoft.SqlServer.Management.XEvent
Assembly:  Microsoft.SqlServer.Management.XEvent (in Microsoft.SqlServer.Management.XEvent.dll)

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

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

NameDescription
System_CAPS_pubmethodSession()

Initializes a new instance of Session class.

System_CAPS_pubmethodSession(BaseXEStore^, String^)

Initializes a new instance of Session class.

NameDescription
System_CAPS_protpropertyAbstractIdentityKey

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubpropertyAutoStart

Gets or sets a value indicating whether the AutoStart object is active or not.

System_CAPS_pubpropertyEventRetentionMode

Gets or sets the EventRetentionMode object.

System_CAPS_pubpropertyEvents

Gets the EventCollection of the session.

System_CAPS_pubpropertyID

Gets the ID object.

System_CAPS_pubpropertyIdentityKey

Gets the identity key of the session.

System_CAPS_pubpropertyIsRunning

Gets a value indicating whether this session is running.

System_CAPS_pubpropertyMaxDispatchLatency

Gets or sets the maximum dispatch latency in seconds.

System_CAPS_pubpropertyMaxEventSize

Gets or sets the size in KB of the maximum event for the session.

System_CAPS_pubpropertyMaxMemory

Gets or sets the maximum memory in KB of the session.

System_CAPS_pubpropertyMemoryPartitionMode

Gets or sets the memory partition mode from an enumeration with options for perNode, perCpu, or none.

System_CAPS_pubpropertyMetadata

Returns metadata about the instance and its domain.(Inherited from SfcInstance.)

System_CAPS_pubpropertyName

Gets the name of the Session object.

System_CAPS_pubpropertyParent

Gets or sets the parent XEStore object.

System_CAPS_pubpropertyProperties

Returns a collection instance properties.(Inherited from SfcInstance.)

System_CAPS_pubpropertyStartTime

Gets the start time.

System_CAPS_pubpropertyState

Gets the state of the object used in Alter function in session.

System_CAPS_pubpropertyTargets
System_CAPS_pubpropertyTrackCausality

Gets or sets a Boolean value indicating whether the TrackCausality object is activated.

System_CAPS_pubpropertyUrn

Returns the uniform resource name of the SfcInstance object.(Inherited from SfcInstance.)

NameDescription
System_CAPS_pubmethodAddEvent(EventInfo^)

Adds a new Event object to the session.

System_CAPS_pubmethodAddEvent(String^)

Adds a new Event object to the session from fully qualified event name.

System_CAPS_pubmethodAddTarget(String^)

Adds a new Target object to the session.

System_CAPS_pubmethodAddTarget(TargetInfo^)

Adds a new Target object to the session.

System_CAPS_pubmethodAlter()

Alters the Session object on the server.

System_CAPS_pubmethodCreate()

Creates the Session object on the server.

System_CAPS_protmethodCreateIdentityKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodDiscover(ISfcDependencyDiscoveryObjectSink^)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodDrop()

Drops the Session object on the server.

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodGetChildCollection(String^)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetDomain()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticGetObjectFactory()

Gets the SQL Foundation Class object factory.

System_CAPS_pubmethodGetPropertySet()

Returns the set of properties for the SfcInstance object.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodGetTypeMetadataImpl()

Indicates the domains that override by returning the right TypeMetadata class directly. Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_protmethodInitializeUIPropertyState()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_protmethodOnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs^)

Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)

System_CAPS_protmethodOnPropertyValueChanges(PropertyChangedEventArgs^)

Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)

System_CAPS_pubmethodRefresh()

Refreshes the object's properties by reading them from the server.(Inherited from SfcInstance.)

System_CAPS_pubmethodRemoveEvent(Event^)

Removes the specified Event object from the session.

System_CAPS_pubmethodRemoveTarget(Target^)

Removes the Target object from the session.

System_CAPS_protmethodResetKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodScriptAlter()

Gets the alteration ISfcScript for the session.

System_CAPS_pubmethodScriptCreate()

Gets the creation ISfcScript for the session.

System_CAPS_pubmethodScriptDrop()

Gets the drop ISfcScript for the session.

System_CAPS_pubmethodSerialize(XmlWriter^)

Serializes the instance to XML.(Inherited from SfcInstance.)

System_CAPS_pubmethodStart()

Starts the Session object.

System_CAPS_pubmethodStop()

Stops the Session object.

System_CAPS_pubmethodToString()

Returns a string representation of the instance Urn.(Inherited from SfcInstance.)

System_CAPS_pubmethodValidate(String^)

Validates the specified method name.

System_CAPS_pubmethodValidate(String^, array<Object^>^)

Validates the method specified by the name parameter.

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticAutoStartProperty

Specifies the auto start property session.

System_CAPS_pubfieldSystem_CAPS_staticDefaultDispatchLatency

Default dispatch latency is 30 seconds.

System_CAPS_pubfieldSystem_CAPS_staticDefaultMaxMemory

The maximum amount of memory by default is 4 MB.

System_CAPS_pubfieldSystem_CAPS_staticEventRetentionModeProperty

Specifies the property of the event retention mode.

System_CAPS_pubfieldSystem_CAPS_staticInfiniteDispatchLatency

0 indicates that dispatch latency is infinite.

System_CAPS_pubfieldSystem_CAPS_staticMaxDispatchLatencyProperty

Specifies the maximum dispatch latency property.

System_CAPS_pubfieldSystem_CAPS_staticMaxEventSizeProperty

Shows the maximum event size of the property.

System_CAPS_pubfieldSystem_CAPS_staticMaxMemoryProperty

Specifies the maximum memory property.

System_CAPS_pubfieldSystem_CAPS_staticMemoryPartitionModeProperty

Specifies a memory partition mode property.

System_CAPS_pubfieldSystem_CAPS_staticNotStarted

Session is currently not running.

System_CAPS_pubfieldSystem_CAPS_staticTrackCausalityProperty

The track casualty property of the session.

System_CAPS_pubfieldSystem_CAPS_staticTypeTypeName

The name of the type.

NameDescription
System_CAPS_pubeventPropertyChanged

Occurs when a property value changes.(Inherited from SfcInstance.)

System_CAPS_pubeventPropertyMetadataChanged

Occurs when the metadata for a property has changed.(Inherited from SfcInstance.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcDiscoverObject::Discover(ISfcDependencyDiscoveryObjectSink^)

Discovers or alters dependency actions and events in the Session object.

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

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: