Subscription Class

Definition

Namespace:

Microsoft.SqlServer.Replication

Assembly:

Microsoft.SqlServer.Rmo.dll

Represents information at the Publisher for a subscription to either a merge or a transactional publication. Subscription is a base class from which the TransSubscription class and the MergeSubscription class are derived.

public ref class Subscription abstract : Microsoft::SqlServer::Replication::ReplicationObject

public abstract class Subscription : Microsoft.SqlServer.Replication.ReplicationObject

type Subscription = class
    inherit ReplicationObject

Public MustInherit Class Subscription
Inherits ReplicationObject

Inheritance

Object

ReplicationObject

Subscription

Derived

Microsoft.SqlServer.Replication.MergeSubscription

Microsoft.SqlServer.Replication.TransSubscription

Remarks

The TransSubscription class and the MergeSubscription class are used to create push subscriptions.

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

Subscription()

Creates a new instance of the Subscription class.

Properties

AgentJobId	Gets the ID of the agent job used to synchronize the subscription.
AgentOffload	Gets or sets whether the synchronization agent runs on a computer other than the one where the agent job was created. This property is no longer supported for Distributors running Microsoft SQL Server 2005 and later.
AgentOffloadServer	Gets or sets the name of the remote computer where the agent runs when using remote agent activation.
AgentSchedule	Gets the schedule for the agent job used to synchronize 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)
CreateSyncAgentByDefault	Gets or sets whether the agent job used to synchronize the subscription is created by default.
DatabaseName	Gets or sets the name of the publication database.
EnabledForSynchronizationManager	Specifies whether the subscription can be synchronized using Microsoft Windows Synchronization Manager.
IsExistingObject	Gets whether the object exists on the server or not. (Inherited from ReplicationObject)
Name	Gets the name assigned to an existing subscription.
PublicationName	Gets or sets the name of the publication to which the subscription subscribes.
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 subscription.
SubscriberName	Gets or sets the name of the instance of Microsoft SQL Server that is the Subscriber.
SubscriberSecurity	Gets the security context used to connect to the Subscriber.
SubscriptionDBName	Gets or sets the name of the database on the Subscriber that receives the replicated data.
SubscriptionType	Gets whether the subscription registration is for a push or pull subscription.
SynchronizationAgentName	Gets or sets the name of the agent job created to synchronize the subscription.
SynchronizationAgentProcessSecurity	Gets the security context that is used to specify the Microsoft Windows account under which the synchronization agent job runs to synchronize the subscription.
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)

Methods

CheckValidCreation()	Checks the valid replication creation. (Inherited from ReplicationObject)
CheckValidDefinition(Boolean)	Indicates whether the subscription definition is valid.
CommitPropertyChanges()	Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject)
Create()	Creates the subscription registration at the Publisher.
Decouple()	Decouples the referenced replication object from the server. (Inherited from ReplicationObject)
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)
Remove()	Deletes the subscription registration at the Publisher and removes replication objects at the Subscriber for a push subscription.
Script(ScriptOptions)	Returns a Transact-SQL script that can be used to create or delete the subscription.