DistributionSubscription Class

Represents information stored at the Distributor about a subscription to a transactional or snapshot publication.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.DistributionSubscription

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

Syntax

'Declaration
Public NotInheritable Class DistributionSubscription _
    Inherits ReplicationObject
'Usage
Dim instance As DistributionSubscription

public sealed class DistributionSubscription : ReplicationObject

public ref class DistributionSubscription sealed : public ReplicationObject

[<SealedAttribute>]
type DistributionSubscription =  
    class 
        inherit ReplicationObject 
    end

public final class DistributionSubscription extends ReplicationObject

The DistributionSubscription type exposes the following members.

Constructors

	Name	Description
	DistributionSubscription()	Creates a new instance of the DistributionSubscription class.
	DistributionSubscription(String, String, String, String, String, String, ServerConnection)	Creates a new instance of the DistributionSubscription class with the required properties and with a connection to the Distributor.

Top

Properties

	Name	Description
	AgentJobId	Gets the ID of the SQL Server Agent job that synchronizes the Subscription.
	AgentSchedule	Gets the synchronization agent schedule for the subscription.
	CachePropertyChanges	Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
	ConnectionContext	Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
	DistributionAgent	Gets the name of the SQL Server Agent job that is used to synchronize the subscription.
	DistributionDBName	Gets or sets the name of the distribution database.
	IsExistingObject	Gets whether the object exists on the server or not. (Inherited from ReplicationObject.)
	Name	Gets the name of the subscription.
	PublicationDBName	Gets or sets the name of the publication database.
	PublicationName	Gets or sets the name of the publication to which the subscription belongs.
	PublisherName	Gets or sets the Publisher of the publication to which the subscription belongs.
	SqlServerName	Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
	Status	Gets or sets the status of the subscription.
	SubscriberName	Gets or sets the name of the Subscriber.
	SubscriptionDBName	Gets or sets the name of the subscription database.
	SubscriptionType	Gets or sets whether the Distribution agent runs at the Distributor (Push) or at the Subscriber (Pull).
	SyncType	Gets or sets the manner in which the subscription is initialized.
	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
	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.)
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	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.)
	Script	Infrastructure. Generates a Transact-SQL script for the subscription.
	ToString	(Inherited from Object.)

Top

Remarks

The DistributionSubscription class is primarily used by SQL Server Management Studio to maintain subscriptions to non-SQL Server Publications. Use an instance of the TransSubscription or class to obtain information on subscriptions registered with a SQL Server Publisher.

The DistributionSubscription class can only be used to return information about an existing subscription. You must use an instance of the TransSubscription class to create or remove a subscription to a transactional or snapshot publication.

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