BaseXEStore Class

Reference

Definition

Namespace:: Microsoft.SqlServer.Management.XEvent

Assembly:: Microsoft.SqlServer.Management.XEvent.dll

Package:: Microsoft.SqlServer.SqlManagementObjects v150.18208.0

Package:: Microsoft.SqlServer.SqlManagementObjects v160.2004021.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public abstract class BaseXEStore : Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcDomain

type BaseXEStore = class
    inherit SfcInstance
    interface ISfcDomain
    interface ISfcDomainLite
    interface ISfcHasConnection

Public MustInherit Class BaseXEStore
Inherits SfcInstance
Implements ISfcDomain

Inheritance: Object

SfcInstance
BaseXEStore

Derived: Microsoft.SqlServer.Management.XEvent.XEStore

Microsoft.SqlServer.Management.XEventDbScoped.DatabaseXEStore

Implements: ISfcDomain ISfcDomainLite ISfcHasConnection

Constructors

BaseXEStore()	Don't ever call this, or if you do remember to set SfcConnection
BaseXEStore(ISfcConnection)	Initializes a new instance of the BaseXEStore class.

Properties

AbstractIdentityKey	(Inherited from SfcInstance)
EtwClassicSyncTargetInfo	Gets the etw_classic_sync_target target info.
EventCounterTargetInfo	Gets the event_counter target info.
EventFileTargetInfo	Gets the event_file target info.
ExecutionEngine	Gets ExecutionEngine to perform operations on the Store.
HistogramTargetInfo	Gets the histogram target info.
IdentityKey	This is used by SFC.
KeyChain	Returns the identity path of the object (Inherited from SfcInstance)
Metadata	(Inherited from SfcInstance)
Name	Gets the name of XEStore.
ObjectInfoSet	Gets BaseXEStore.ObjectMetadata for the Store.
OriginalConnection	Gets connection used to instantiate the store
Package0Package	Gets the package0 package.
Packages	Gets the packages.
PairMatchingTargetInfo	Gets the pair_matching target info.
Parent	Parent is not something that is kept local, it is implied from the keychain The concept of a parent is really about the hiearchy up and under the root if we only do this via parents then we will not be able to instantiate objects with only lightweight SfcKeyChain sets Setting the parent is therefor a helper operation to set a keychain (Inherited from SfcInstance)
Properties	(Inherited from SfcInstance)
PropertyStorageProvider	This property returns the default implementation of SFC for ISfcPropertyStorageProvider interface, it can be overriden in the child classes to return another storage provider (i.e. flat properties list) (Inherited from SfcInstance)
RingBufferTargetInfo	Gets the ring_buffer target info.
RunningSessionCount	Gets the running session count.
ServerName	Gets the name of XEStore.
Sessions	Gets the sessions.
SfcConnection	Gets or sets the SQL store connection.
State	(Inherited from SfcInstance)
StoreProvider	Gets provider for store operations.
Urn	Create a new Urn string on each request and return it. (Inherited from SfcInstance)

Methods

AlterImpl()	(Inherited from SfcInstance)
CheckObjectCreated()	To be called from domain for when an API requires the object to be Created Stronger than CheckObjectState (Inherited from SfcInstance)
CheckObjectState()	To be called from domain for any access to the object (Inherited from SfcInstance)
CreateIdentityKey()	This is used by SFC.
CreateImpl()	(Inherited from SfcInstance)
CreateSession(String)	A wrapper for Session constructor to avoid accidentally passing an wrong parent.
CreateSessionFromTemplate(String, String)	Creates a session from template.
Discover(ISfcDependencyDiscoveryObjectSink)	(Inherited from SfcInstance)
DropImpl()	(Inherited from SfcInstance)
FormatFieldValue(String, Guid, String)	Formats the field value based on the type information.
FormatPredicateExpression(PredExpr)	Gets the string representation of the predicate expression.
GetChildCollection(String)	This is used by SFC.
GetComparer()	Gets the comparer for the child collections
GetDomain()	(Inherited from SfcInstance)
GetEventProvider(Event)	Gets provider to perform Event operations.
GetPropertySet()	(Inherited from SfcInstance)
GetSessionProivder(Session)	Gets provider to perform Session operations.
GetStoreProvider()	Gets provider to perform Store operations.
GetTargetProvider(Target)	Gets provider to perform Target operations.
GetTypeMetadataImpl()	(Inherited from SfcInstance)
InitConnection()	Initializes connections and related objects. Should not be called directly.
InitializeUIPropertyState()	Overridable from the child objects who care about initializing their states (dynamic metadata which is currently the ".Enabled" property) (Inherited from SfcInstance)
MarkForDropImpl(Boolean)	(Inherited from SfcInstance)
MarkRootAsConnected()	(Inherited from SfcInstance)
MoveImpl(SfcInstance)	(Inherited from SfcInstance)
OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs)	(Inherited from SfcInstance)
OnPropertyValueChanges(PropertyChangedEventArgs)	(Inherited from SfcInstance)
PostAlter(Object)	(Inherited from SfcInstance)
PostCreate(Object)	(Inherited from SfcInstance)
PostDrop(Object)	(Inherited from SfcInstance)
PostMove(Object)	(Inherited from SfcInstance)
PostRename(Object)	(Inherited from SfcInstance)
Refresh()	refreshes the object's properties by reading them from the server (Inherited from SfcInstance)
RenameImpl(SfcKey)	(Inherited from SfcInstance)
ResetKey()	(Inherited from SfcInstance)
SaveSessionToTemplate(Session, String, Boolean)	Saves the session to template.
Serialize(XmlWriter)	(Inherited from SfcInstance)
SetConnection(ISfcConnection)	Sets the active connection.
ToString()	The string identity of a policy store is the associated Server name.
UpdateUIPropertyState()	(Inherited from SfcInstance)
Validate()	Basic child object's validation (Inherited from SfcInstance)

Events

propertyChanged	(Inherited from SfcInstance)
PropertyChanged	(Inherited from SfcInstance)
propertyMetadataChanged	(Inherited from SfcInstance)
PropertyMetadataChanged	(Inherited from SfcInstance)

Explicit Interface Implementations

ISfcDomain.GetExecutionEngine()	Gets the execution engine.
ISfcDomain.GetKey(IUrnFragment)	returns the Key object given Urn fragment
ISfcDomain.GetType(String)	Gets the type.
ISfcDomain.GetTypeMetadata(String)
ISfcDomain.UseSfcStateManagement()
ISfcDomainLite.DomainInstanceName	Gets the name of the domain instance.
ISfcDomainLite.DomainName	Gets the name of the domain.
ISfcDomainLite.GetLogicalVersion()	Returns the logical version of the domain
ISfcHasConnection.ConnectionContext
ISfcHasConnection.GetConnection()	Get the current connection to query on. Return a connection supporting a single serial query, so the query must end before another one may begin.
ISfcHasConnection.GetConnection(SfcObjectQueryMode)	Get the current connection to query on. Return a connection supporting either a single serial query or multiple simultaneously open queries as requested.
ISfcHasConnection.SetConnection(ISfcConnection)	Sets the active connection.

Applies to