PublicationMonitor Class

Monitors a publication.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.PublicationMonitor

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

Syntax

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

The PublicationMonitor type exposes the following members.

Constructors

  Name Description
Public method PublicationMonitor() Creates a new instance of the PublicationMonitor class.
Public method 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.

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.
Public property ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public property Description Gets the textual description of the publication.
Public property DistributionDBName Gets the name of the distribution database used by the publication.
Public property ExcludeAnonymousSubscriptions Gets or sets whether anonymous subscriptions are excluded from or included in the monitor results.
Public property IsExistingObject Gets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public property Name Gets or sets the name of the monitored publication.
Public property PublicationDBName Gets or sets the name of the publication database.
Public property PublisherName Gets or sets the name of the Publisher.
Public property QueueReaderAgentName
Public property SqlServerName Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public property Status Gets the status of the publication.
Public property StatusAndWarning Gets the status and warnings of the referenced publication on the Distributor, including all of the agents associated for the publication.
Public property Type Gets the type of replication in which the publication participates.
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 ChangeMonitorThreshold Changes the monitoring threshold metric for a publication.
Protected method CheckValidCreation Infrastructure. (Inherited from ReplicationObject.)
Protected method CheckValidDefinition Infrastructure. (Inherited from ReplicationObject.)
Public method CleanUpTracerTokenHistory(DateTime) Removes all metadata for tracer tokens older than the specified date from a database published using transactional replication.
Public method CleanUpTracerTokenHistory(Int32) Removes metadata for a specific tracer token from a database published using transactional replication.
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 EnumErrorRecords Returns information about errors associated with a specified error ID that occurred during a synchronization session.
Public method EnumLogReaderAgent Returns information for the Log Reader Agent job used by the monitored publication.
Public method EnumMonitorThresholds Returns the replication monitor thresholds defined for this publication.
Public method EnumQueueReaderAgent Returns information for the Queue Reader Agent job used by the monitored publication.
Public method EnumSnapshotAgent Returns information for the Snapshot Agent job used by the monitored publication.
Public method EnumSubscriptions Returns information on subscriptions that are subscribed to the monitored publication.
Public method EnumSubscriptions2 Returns additional information on subscriptions that are subscribed to the monitored publication.
Public method EnumTracerTokenHistory Returns Subscriber latency information for a single tracer token record inserted into a monitored transactional publication.
Public method EnumTracerTokens Returns all tracer tokens that have been inserted into the monitored transactional publication.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GetChangeCommand Infrastructure. (Inherited from ReplicationObject.)
Protected method GetCreateCommand Infrastructure. (Inherited from ReplicationObject.)
Protected method GetDropCommand Infrastructure. (Inherited from ReplicationObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method InternalRefresh Infrastructure. (Inherited from ReplicationObject.)
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.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Refresh Reloads the properties of the object. (Inherited from ReplicationObject.)
Public method ToString (Inherited from Object.)
Public method TransPendingCommandInfo Returns information about pending commands for a subscription.

Top

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.

This namespace, class, or member is supported only in version 2.0 of the .NET Framework.

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.