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
	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.

Top

Properties

	Name	Description
	CachePropertyChanges	Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
	CacheRefreshPolicy	Infrastructure.
	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
	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.)

Top

Methods

	Name	Description
	ChangeMonitorThreshold	Changes the monitoring threshold metric for a publication.
	CheckValidCreation	Infrastructure. (Inherited from ReplicationObject.)
	CheckValidDefinition	Infrastructure. (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	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	Returns additional information on subscriptions that are subscribed to the monitored publication.
	EnumTracerTokenHistory	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.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetChangeCommand	Infrastructure. (Inherited from ReplicationObject.)
	GetCreateCommand	Infrastructure. (Inherited from ReplicationObject.)
	GetDropCommand	Infrastructure. (Inherited from ReplicationObject.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	InternalRefresh	Infrastructure. (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.)
	MemberwiseClone	(Inherited from Object.)
	Refresh	Reloads the properties of the object. (Inherited from ReplicationObject.)
	ToString	(Inherited from Object.)
	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.

See Also

Reference

Microsoft.SqlServer.Replication Namespace

Other Resources

How to: Programmatically Monitor Replication (RMO Programming)