DatabaseXEStore Class
Definition
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 sealed class DatabaseXEStore : Microsoft.SqlServer.Management.XEvent.BaseXEStore, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcDomaintype DatabaseXEStore = class
inherit BaseXEStore
interface ISfcDomain
interface ISfcDomainLite
interface ISfcHasConnectionPublic NotInheritable Class DatabaseXEStore
Inherits BaseXEStore
Implements ISfcDomain- Inheritance
- Implements
Constructors
| DatabaseXEStore() |
Initializes a new instance of the DatabaseXEStore class. This constructor is only used to support serialization. |
| DatabaseXEStore(SqlStoreConnection, String) |
Initializes a new instance of the DatabaseXEStore class. |
| DatabaseXEStore(SqlStoreConnection) |
Constructs a new DatabaseXEStore instance whose name is the same as the current active database |
Fields
| TypeTypeName |
Type name. |
Properties
| AbstractIdentityKey | (Inherited from SfcInstance) |
| EtwClassicSyncTargetInfo |
Gets the etw_classic_sync_target target info. (Inherited from BaseXEStore) |
| EventCounterTargetInfo |
Gets the event_counter target info. (Inherited from BaseXEStore) |
| EventFileTargetInfo |
Gets the event_file target info. (Inherited from BaseXEStore) |
| ExecutionEngine |
Gets ExecutionEngine to perform operations on the Store. (Inherited from BaseXEStore) |
| HistogramTargetInfo |
Gets the histogram target info. (Inherited from BaseXEStore) |
| IdentityKey |
Returns the key associated with the store. |
| 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. (Inherited from BaseXEStore) |
| OriginalConnection |
Gets connection used to instantiate the store (Inherited from BaseXEStore) |
| Package0Package |
Gets the package0 package. (Inherited from BaseXEStore) |
| Packages |
Gets the packages. (Inherited from BaseXEStore) |
| PairMatchingTargetInfo |
Gets the pair_matching target info. (Inherited from BaseXEStore) |
| 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. (Inherited from BaseXEStore) |
| RunningSessionCount |
Gets the running session count. (Inherited from BaseXEStore) |
| ServerName |
Gets ServerName for the store. |
| Sessions |
Gets the sessions. (Inherited from BaseXEStore) |
| SfcConnection |
Gets or sets the SQL store connection. (Inherited from BaseXEStore) |
| State | (Inherited from SfcInstance) |
| StoreProvider |
Gets provider for store operations. (Inherited from BaseXEStore) |
| 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. (Inherited from BaseXEStore) |
| CreateImpl() | (Inherited from SfcInstance) |
| CreateSession(String) |
A wrapper for Session constructor to avoid accidentally passing an wrong parent. (Inherited from BaseXEStore) |
| CreateSessionFromTemplate(String, String) |
Creates a session from template. (Inherited from BaseXEStore) |
| Discover(ISfcDependencyDiscoveryObjectSink) | (Inherited from SfcInstance) |
| DropImpl() | (Inherited from SfcInstance) |
| FormatFieldValue(String, Guid, String) |
Formats the field value based on the type information. (Inherited from BaseXEStore) |
| FormatPredicateExpression(PredExpr) |
Gets the string representation of the predicate expression. (Inherited from BaseXEStore) |
| GetChildCollection(String) |
This is used by SFC. (Inherited from BaseXEStore) |
| GetComparer() |
Gets the comparer for the child collections (Inherited from BaseXEStore) |
| GetDomain() | (Inherited from SfcInstance) |
| GetEventProvider(Event) |
Gets provider to perform Event operations. (Inherited from BaseXEStore) |
| GetPropertySet() | (Inherited from SfcInstance) |
| GetSessionProivder(Session) |
Gets provider to perform Session operations. (Inherited from BaseXEStore) |
| GetStoreProvider() |
Gets provider to perform Store operations. (Inherited from BaseXEStore) |
| GetTargetProvider(Target) |
Gets provider to perform Target operations. (Inherited from BaseXEStore) |
| GetTypeMetadataImpl() | (Inherited from SfcInstance) |
| InitConnection() |
Initializes connections and related objects. Should not be called directly. (Inherited from BaseXEStore) |
| 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) |
| Serialize(XmlWriter) | (Inherited from SfcInstance) |
| SetConnection(ISfcConnection) |
Sets the active connection. (Inherited from BaseXEStore) |
| ToString() |
Produces a string representing the store. |
| 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 a Key object given a 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 |
Gets connection context. |
| 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. |