Compartilhar via


Classe Session

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

Hierarquia de herança

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

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

Sintaxe

'Declaração
Public NotInheritable Class Session _
    Inherits SfcInstance _
    Implements ISfcCreatable, ICreatable, ISfcAlterable, IAlterable,  _
    ISfcDroppable, IDroppable, ISfcValidate, ISfcDiscoverObject
'Uso
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

O tipo Session expõe os membros a seguir.

Construtores

  Nome Descrição
Método público Session() Initializes a new instance of Session class.
Método público Session(XEStore, String) Initializes a new instance of Session class.

Início

Propriedades

  Nome Descrição
Propriedade protegida AbstractIdentityKey Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SfcInstance.)
Propriedade pública AutoStart Gets or sets a value indicating whether the AutoStart object is active or not.
Propriedade pública EventRetentionMode Gets or sets the EventRetentionMode object.
Propriedade pública Events Gets the EventCollection of the session.
Propriedade pública ID Gets the ID object.
Propriedade pública IdentityKey Gets the identity key of the session.
Propriedade pública IsRunning Gets a value indicating whether this session is running.
Propriedade pública MaxDispatchLatency Gets or sets the maximum dispatch latency in seconds.
Propriedade pública MaxEventSize Gets or sets the size in KB of the maximum event for the session.
Propriedade pública MaxMemory Gets or sets the maximum memory in KB of the session.
Propriedade pública MemoryPartitionMode Gets or sets the memory partition mode from an enumeration with options for perNode, perCpu, or none.
Propriedade pública Metadata Returns metadata about the instance and its domain. (Herdado de SfcInstance.)
Propriedade pública Name Gets the name of the Session object.
Propriedade pública Parent Gets or sets the parent XEStore object.
Propriedade pública Properties Returns a collection instance properties. (Herdado de SfcInstance.)
Propriedade pública StartTime Gets the start time.
Propriedade pública State Gets the state of the object used in Alter function in session.
Propriedade pública Targets Gets the TargetCollection.
Propriedade pública TrackCausality Gets or sets a Boolean value indicating whether the TrackCausality object is activated.
Propriedade pública Urn Returns the uniform resource name of the SfcInstance object. (Herdado de SfcInstance.)

Início

Métodos

  Nome Descrição
Método público AddEvent(String) Adds a new Event object to the session from fully qualified event name.
Método público AddEvent(EventInfo) Adds a new Event object to the session.
Método público AddTarget(String) Adds a new Target object to the session.
Método público AddTarget(TargetInfo) Adds a new Target object to the session.
Método público Alter Alters the Session object on the server.
Método público Create Creates the Session object on the server.
Método protegido CreateIdentityKey Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SfcInstance.)
Método público Discover Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SfcInstance.)
Método público Drop Drops the Session object on the server.
Método público Equals (Herdado de Object.)
Método protegido GetChildCollection Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SfcInstance.)
Método público GetDomain Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SfcInstance.)
Método público GetHashCode (Herdado de Object.)
Método públicoMembro estático GetObjectFactory Gets the SQL Foundation Class object factory.
Método público GetPropertySet Returns the set of properties for the SfcInstance object. (Herdado de SfcInstance.)
Método público GetType (Herdado de Object.)
Método protegido GetTypeMetadataImpl Indicates the domains that override by returning the right TypeMetadata class directly. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SfcInstance.)
Método protegido InitializeUIPropertyState Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SfcInstance.)
Método protegido OnPropertyMetadataChanges Invoked whenever the effective value of any SfcInstance metadata is updated. (Herdado de SfcInstance.)
Método protegido OnPropertyValueChanges Invoked whenever the effective value of any SfcInstance property is updated. (Herdado de SfcInstance.)
Método público Refresh Refreshes the object's properties by reading them from the server. (Herdado de SfcInstance.)
Método público RemoveEvent Removes the specified Event object from the session.
Método público RemoveTarget Removes the Target object from the session.
Método protegido ResetKey Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SfcInstance.)
Método público ScriptAlter Gets the alteration ISfcScript for the session.
Método público ScriptCreate Gets the creation ISfcScript for the session.
Método público ScriptDrop Gets the drop ISfcScript for the session.
Método público Serialize Serializes the instance to XML. (Herdado de SfcInstance.)
Método público Start Starts the Session object.
Método público Stop Stops the Session object.
Método público ToString Returns a string representation of the instance Urn. (Herdado de SfcInstance.)
Método público Validate(String) Validates the specified method name.
Método público Validate(String, array<Object[]) Validates the method specified by the name parameter.

Início

Eventos

  Nome Descrição
Evento público PropertyChanged CLS-compliant event for property changes. (Herdado de SfcInstance.)
Evento público PropertyMetadataChanged CLS-compliant event for property metadata changes. (Herdado de SfcInstance.)

Início

Campos

  Nome Descrição
Campo públicoMembro estático DefaultDispatchLatency Default dispatch latency is 30 seconds.
Campo públicoMembro estático DefaultMaxMemory The maximum amount of memory by default is 4 MB.
Campo públicoMembro estático InfiniteDispatchLatency 0 indicates that dispatch latency is infinite.
Campo públicoMembro estático NotStarted Session is currently not running.

Início

Implementações de interfaces explícitas

  Nome Descrição
Implementações de interfaces explícitasMétodo privado ISfcDiscoverObject.Discover Discovers or alters dependency actions and events in the Session object.

Início

Comentários

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

Segurança de thread

Qualquer membro público static (Shared no Visual Basic) desse tipo é seguro para threads. Não há garantia de que qualquer membro de instância seja seguro para threads.

Consulte também

Referência

Namespace Microsoft.SqlServer.Management.XEvent