PublicationMonitor 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.
Monitors a publication.
public ref class PublicationMonitor sealed : Microsoft::SqlServer::Replication::ReplicationObjectpublic sealed class PublicationMonitor : Microsoft.SqlServer.Replication.ReplicationObjecttype PublicationMonitor = class
inherit ReplicationObjectPublic NotInheritable Class PublicationMonitor
Inherits ReplicationObject- Inheritance
Remarks
An exception will be thrown if the specified Distributor, distribution database, and Publisher are not configured for replication.
PublicationMonitor requires a connection to the Distributor.
Thread Safety
Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Constructors
| PublicationMonitor() |
Creates a new instance of the PublicationMonitor class. |
| PublicationMonitor(String, String, String, String, ServerConnection) |
Creates a new instance of the PublicationMonitor class with the specified name, distribution database, Publisher, publication database, and connection to the Distributor. |
Properties
| CachePropertyChanges |
Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject) |
| CacheRefreshPolicy |
Gets or sets the monitor cache refresh policy. |
| ConnectionContext |
Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject) |
| Description |
Gets the textual description of the publication. |
| DistributionDBName |
Gets the name of the distribution database used by the publication. |
| ExcludeAnonymousSubscriptions |
Gets or sets whether anonymous subscriptions are excluded from or included in the monitor results. |
| IsExistingObject |
Gets whether the object exists on the server or not. (Inherited from ReplicationObject) |
| Name |
Gets or sets the name of the monitored publication. |
| PublicationDBName |
Gets or sets the name of the publication database. |
| PublisherName |
Gets or sets the name of the Publisher. |
| QueueReaderAgentName |
Gets the queue reader agent name. |
| SqlServerName |
Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject) |
| Status |
Gets the status of the publication. |
| StatusAndWarning |
Gets the status and warnings of the referenced publication on the Distributor, including all of the agents associated for the publication. |
| Type |
Gets the type of replication in which the publication participates. |
| UserData |
Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject) |
Methods
| ChangeMonitorThreshold(Int32, Boolean, Int32, Int32) |
Changes the monitoring threshold metric for a publication. |
| CheckValidCreation() |
Checks the valid replication creation. (Inherited from ReplicationObject) |
| CheckValidDefinition(Boolean) |
Indicates whether the definition is valid. (Inherited from ReplicationObject) |
| CleanUpTracerTokenHistory(DateTime) |
Removes all metadata for tracer tokens older than the specified date from a database published using transactional replication. |
| CleanUpTracerTokenHistory(Int32) |
Removes metadata for a specific tracer token from a database published using transactional replication. |
| CommitPropertyChanges() |
Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject) |
| Decouple() |
Decouples the referenced replication object from the server. (Inherited from ReplicationObject) |
| EnumErrorRecords(Int32) |
Returns information about errors associated with a specified error ID that occurred during a synchronization session. |
| EnumLogReaderAgent() |
Returns information for the Log Reader Agent job used by the monitored publication. |
| EnumMonitorThresholds() |
Returns the replication monitor thresholds defined for this publication. |
| EnumQueueReaderAgent() |
Returns information for the Queue Reader Agent job used by the monitored publication. |
| EnumSnapshotAgent() |
Returns information for the Snapshot Agent job used by the monitored publication. |
| EnumSubscriptions() |
Returns information on subscriptions that are subscribed to the monitored publication. |
| EnumSubscriptions2(SubscriptionResultOption) |
Returns additional information on subscriptions that are subscribed to the monitored publication. |
| EnumTracerTokenHistory(Int32) |
Returns Subscriber latency information for a single tracer token record inserted into a monitored transactional publication. |
| EnumTracerTokens() |
Returns all tracer tokens that have been inserted into the monitored transactional publication. |
| GetChangeCommand(StringBuilder, String, String) |
Returns the change command from the replication. (Inherited from ReplicationObject) |
| GetCreateCommand(StringBuilder, Boolean, ScriptOptions) |
Returns the create command from the replication. (Inherited from ReplicationObject) |
| GetDropCommand(StringBuilder, Boolean) |
Returns the drop command from the replication. (Inherited from ReplicationObject) |
| InternalRefresh(Boolean) |
Initiates an internal refresh from the replication. (Inherited from ReplicationObject) |
| Load() |
Loads the properties of an existing object from the server. (Inherited from ReplicationObject) |
| LoadProperties() |
Loads the properties of an existing object from the server. (Inherited from ReplicationObject) |
| Refresh() |
Reloads the properties of the object. (Inherited from ReplicationObject) |
| TransPendingCommandInfo(String, String, SubscriptionOption) |
Returns information about pending commands for a subscription. |