Subscription Members

  • Article

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.

The following tables list the members exposed by the Subscription type.

Protected Constructors

  Name Description
Subscription Creates a new instance of the Subscription class.

Top

Public Properties

  Name Description
ms158424.pubproperty(en-US,SQL.90).gif AgentJobId Gets the ID of the agent job used to synchronize the subscription.
ms158424.pubproperty(en-US,SQL.90).gif 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.
ms158424.pubproperty(en-US,SQL.90).gif AgentOffloadServer Gets or sets the name of the remote computer where the agent runs when using remote agent activation.
ms158424.pubproperty(en-US,SQL.90).gif AgentSchedule Gets the schedule for the agent job used to synchronize the subscription.
ms158424.pubproperty(en-US,SQL.90).gif CachePropertyChanges  Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (inherited from ReplicationObject)
ms158424.pubproperty(en-US,SQL.90).gif ConnectionContext  Gets or sets the connection to an instance of Microsoft SQL Server. (inherited from ReplicationObject)
ms158424.pubproperty(en-US,SQL.90).gif CreateSyncAgentByDefault Gets or sets whether the agent job used to synchronize the subscription is created by default.
ms158424.pubproperty(en-US,SQL.90).gif DatabaseName Gets or sets the name of the publication database.
ms158424.pubproperty(en-US,SQL.90).gif EnabledForSynchronizationManager Specifies whether the subscription can be synchronized using Microsoft Windows Synchronization Manager.
ms158424.pubproperty(en-US,SQL.90).gif IsExistingObject  Gets whether the object exists on the server or not. (inherited from ReplicationObject)
ms158424.pubproperty(en-US,SQL.90).gif Name Gets the name assigned to an existing subscription.
ms158424.pubproperty(en-US,SQL.90).gif PublicationName Gets or sets the name of the publication to which the subscription subscribes.
ms158424.pubproperty(en-US,SQL.90).gif SqlServerName  Gets the name of the Microsoft SQL Server instance to which this object is connected. (inherited from ReplicationObject)
ms158424.pubproperty(en-US,SQL.90).gif Status Gets the status of the subscription.
ms158424.pubproperty(en-US,SQL.90).gif SubscriberName Gets or sets the name of the instance of Microsoft SQL Server that is the Subscriber.
ms158424.pubproperty(en-US,SQL.90).gif SubscriberSecurity Gets the security context used to connect to the Subscriber.
ms158424.pubproperty(en-US,SQL.90).gif SubscriptionDBName Gets or sets the name of the database on the Subscriber that receives the replicated data.
ms158424.pubproperty(en-US,SQL.90).gif SubscriptionType Gets whether the subscription registration is for a push or pull subscription.
ms158424.pubproperty(en-US,SQL.90).gif SynchronizationAgentName Gets or sets the name of the agent job created to synchronize the subscription.
ms158424.pubproperty(en-US,SQL.90).gif 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.
ms158424.pubproperty(en-US,SQL.90).gif SyncType Gets or sets the manner in which the subscription is initialized.
ms158424.pubproperty(en-US,SQL.90).gif UserData  Gets or sets an object property that allows users to attach their own data to the object. (inherited from ReplicationObject)

Top

Public Methods

(see also Protected Methods )

  Name Description
ms158424.pubmethod(en-US,SQL.90).gif CommitPropertyChanges  Sends all the cached property change statements to the instance of Microsoft SQL Server. (inherited from ReplicationObject)
ms158424.pubmethod(en-US,SQL.90).gif Create Creates the subscription registration at the Publisher.
ms158424.pubmethod(en-US,SQL.90).gif Decouple  Decouples the referenced replication object from the server. (inherited from ReplicationObject)
ms158424.pubmethod(en-US,SQL.90).gif Equals  Overloaded. (inherited from Object )
ms158424.pubmethod(en-US,SQL.90).gif GetHashCode  (inherited from Object )
ms158424.pubmethod(en-US,SQL.90).gif GetType  (inherited from Object )
ms158424.pubmethod(en-US,SQL.90).gif Load  Loads the properties of an existing object from the server. (inherited from ReplicationObject)
ms158424.pubmethod(en-US,SQL.90).gif LoadProperties  Loads the properties of an existing object from the server. (inherited from ReplicationObject)
ms158424.pubmethod(en-US,SQL.90).gifms158424.static(en-US,SQL.90).gif ReferenceEquals  (inherited from Object )
ms158424.pubmethod(en-US,SQL.90).gif Refresh  Reloads the properties of the object. (inherited from ReplicationObject)
ms158424.pubmethod(en-US,SQL.90).gif Remove Deletes the subscription registration at the Publisher and removes replication objects at the Subscriber for a push subscription.
ms158424.pubmethod(en-US,SQL.90).gif Script Returns a Transact-SQL script that can be used to create or delete the subscription.
ms158424.pubmethod(en-US,SQL.90).gif ToString  (inherited from Object )

Top

Protected Methods

  Name Description
ms158424.protmethod(en-US,SQL.90).gif CheckValidCreation  (inherited from ReplicationObject )
ms158424.protmethod(en-US,SQL.90).gif CheckValidDefinition Overridden.  
ms158424.protmethod(en-US,SQL.90).gif Finalize  (inherited from Object )
ms158424.protmethod(en-US,SQL.90).gif GetChangeCommand  (inherited from ReplicationObject )
ms158424.protmethod(en-US,SQL.90).gif GetCreateCommand  (inherited from ReplicationObject )
ms158424.protmethod(en-US,SQL.90).gif GetDropCommand  (inherited from ReplicationObject )
ms158424.protmethod(en-US,SQL.90).gif InternalRefresh  (inherited from ReplicationObject )
ms158424.protmethod(en-US,SQL.90).gif MemberwiseClone  (inherited from Object )

Top

See Also

Reference

Subscription Class
Microsoft.SqlServer.Replication Namespace

Other Resources

Creating, Modifying, and Deleting Subscriptions (RMO Programming)
Subscribing to Publications