ReplicationMonitor 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 replication server.
public ref class ReplicationMonitor sealed : Microsoft::SqlServer::Replication::ReplicationObjectpublic sealed class ReplicationMonitor : Microsoft.SqlServer.Replication.ReplicationObjecttype ReplicationMonitor = class
inherit ReplicationObjectPublic NotInheritable Class ReplicationMonitor
Inherits ReplicationObject- Inheritance
Remarks
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
| ReplicationMonitor() |
Creates a new instance of the ReplicationMonitor class. |
| ReplicationMonitor(ServerConnection) |
Creates a new instance of the ReplicationMonitor class with the specified connection to the instance of Microsoft SQL Server. |
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) |
| ExcludeAnonymousSubscriptions |
Gets whether or not information on anonymous subscriptions is returned. |
| IsExistingObject |
Gets whether the object exists on the server or not. (Inherited from ReplicationObject) |
| Name |
Gets the name of the instance of Microsoft SQL Server that is currently connected. |
| PublisherMonitors |
Gets a collection of PublisherMonitor objects that are used to monitor Publishers that use a monitored Distributor. |
| SqlServerName |
Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject) |
| Status |
Gets the overall status of replication on the Distributor, including all Publishers that use the Distributor. |
| UserData |
Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject) |
Methods
| CheckValidCreation() |
Checks the valid replication creation. (Inherited from ReplicationObject) |
| CheckValidDefinition(Boolean) |
Indicates whether the definition is valid. (Inherited from ReplicationObject) |
| 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) |
| EnumDistributionAgents() |
Returns information on Distribution Agent jobs at the monitored Distributor. |
| EnumErrorRecords(String, Int32) |
Returns information on errors associated with a specified error ID that occurred during a synchronization session. |
| EnumLogReaderAgents() |
Returns information on Log Reader Agent jobs at the monitored Distributor. |
| EnumMergeAgents() |
Returns information on Merge Agent jobs at the monitored Distributor. |
| EnumMiscellaneousAgents() |
Returns information on jobs for miscellaneous replication agents at the monitored Distributor. |
| EnumPublishers() |
Returns information on the Publishers that use the monitored Distributor. |
| EnumPublishers2() |
Returns a list of Publishers that use the currently connected server as the Distributor. |
| EnumQueueReaderAgents() |
Returns information on Queue Reader Agent jobs at the monitored Distributor. |
| EnumQueueReaderAgentSessionDetails(String, Int32, String) |
Returns detailed information about a Queue Reader Agent session. |
| EnumQueueReaderAgentSessions(String, Int32, Int32, Boolean) |
Returns a list of information about the Queue Reader Agent sessions, including status and statistical information. |
| EnumSnapshotAgents() |
Returns information on Snapshot Agent jobs at the monitored Distributor. |
| 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) |
| StatusOf(AgentType) |
Returns the overall status for replication agents at the monitored Distributor by agent type. |