PublisherMonitor Class

Monitors a replication Publisher.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.PublisherMonitor

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

Syntax

'Declaration
Public NotInheritable Class PublisherMonitor _
    Inherits ReplicationObject
'Usage
Dim instance As PublisherMonitor
public sealed class PublisherMonitor : ReplicationObject
public ref class PublisherMonitor sealed : public ReplicationObject
[<SealedAttribute>]
type PublisherMonitor =  
    class 
        inherit ReplicationObject 
    end
public final class PublisherMonitor extends ReplicationObject

The PublisherMonitor type exposes the following members.

Constructors

  Name Description
Public method PublisherMonitor() Creates a new instance of the PublisherMonitor class.
Public method PublisherMonitor(String, ServerConnection) Creates a new instance of the PublisherMonitor class with the specified name and a connection to the Distributor.

Top

Properties

  Name Description
Public property CachePropertyChanges Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
Public property CacheRefreshPolicy Infrastructure. Gets or sets the monitor cache refresh policy.
Public property ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public property DistributionDatabase Gets the name of the distribution database used by the Publisher.
Public property ExcludeAnonymousSubscriptions Gets whether or not information on anonymous subscriptions is returned.
Public property IsExistingObject Gets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public property Name Gets the name of the Publisher.
Public property PublicationMonitors Represents a collection of PublicationMonitor objects, each of which represents a publication defined at the Publisher being monitored.
Public property PublisherType Gets the type of the database server that is the Publisher.
Public property SqlServerName Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public property StatusAndWarning Gets status information and warnings for the monitored threshold metrics on the Publisher.
Public property UserData Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)

Top

Methods

  Name Description
Public method CommitPropertyChanges Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public method Decouple Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public method EnumDatabasePublications Returns information about publications that use a specified publication database.
Public method EnumDatabaseSubscriptions Returns information on subscriptions that belong to publications that use a specified publication database.
Public method EnumDistributionAgentSessionDetails Returns detailed information about a Distribution Agent session.
Public method EnumDistributionAgentSessions Returns information about Distribution Agent sessions.
Public method EnumErrorRecords Returns information on errors associated with a specified error ID that occurred during a synchronization session.
Public method EnumLogReaderAgentSessionDetails Returns detailed information about a Log Reader Agent session.
Public method EnumLogReaderAgentSessions Returns information about Log Reader Agent sessions.
Public method EnumMergeAgentSessionDetails Returns detailed information about a Merge Agent session.
Public method EnumMergeAgentSessionDetails2 Returns additional detailed information about a Merge Agent session.
Public method EnumMergeAgentSessions Returns information about Merge Agent sessions.
Public method EnumMergeAgentSessions2 Returns additional information about Merge Agent sessions.
Public method EnumPublications Returns information on publications at a monitored Publisher.
Public method EnumPublications2 Returns additional information on publications at a monitored Publisher.
Public method EnumSnapshotAgentSessionDetails Returns detailed information about a Snapshot Agent session.
Public method EnumSnapshotAgentSessions Returns information about Snapshot Agent sessions.
Public method EnumSubscriptions Returns information about subscriptions that belong to a publication at the monitored Publisher.
Public method Equals (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method Load Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public method LoadProperties Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public method Refresh Reloads the properties of the object. (Inherited from ReplicationObject.)
Public method ToString (Inherited from Object.)

Top

Remarks

Any method of PublisherMonitor will throw an exception if the Distributor is not installed and the distribution database does not exist.

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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Replication Namespace

Other Resources

NIB Programmatically Monitor Replication (RMO Programming)