Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
MSDN Library

Subscription Class

 

Applies To: SQL Server 2016 Preview

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.

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


[StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, 
	PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8", 
	Name = "Microsoft.SqlServer.Rmo")]
public abstract class Subscription : ReplicationObject

NameDescription
System_CAPS_protmethodSubscription()

Creates a new instance of the Subscription class.

NameDescription
System_CAPS_pubpropertyAgentJobId

Gets the ID of the agent job used to synchronize the subscription.

System_CAPS_pubpropertyAgentOffload

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.

System_CAPS_pubpropertyAgentOffloadServer

Gets or sets the name of the remote computer where the agent runs when using remote agent activation.

System_CAPS_pubpropertyAgentSchedule

Gets the schedule for the agent job used to synchronize the subscription.

System_CAPS_pubpropertyCachePropertyChanges

Gets or sets whether to cache changes made to the replication properties or to apply them immediately.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyConnectionContext

Gets or sets the connection to an instance of Microsoft SQL Server.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyCreateSyncAgentByDefault

Gets or sets whether the agent job used to synchronize the subscription is created by default.

System_CAPS_pubpropertyDatabaseName

Gets or sets the name of the publication database.

System_CAPS_pubpropertyEnabledForSynchronizationManager

Specifies whether the subscription can be synchronized using Microsoft Windows Synchronization Manager.

System_CAPS_pubpropertyIsExistingObject

Gets whether the object exists on the server or not.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyName

Gets the name assigned to an existing subscription.

System_CAPS_pubpropertyPublicationName

Gets or sets the name of the publication to which the subscription subscribes.

System_CAPS_pubpropertySqlServerName

Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)

System_CAPS_pubpropertyStatus

Gets the status of the subscription.

System_CAPS_pubpropertySubscriberName

Gets or sets the name of the instance of Microsoft SQL Server that is the Subscriber.

System_CAPS_pubpropertySubscriberSecurity

Gets the security context used to connect to the Subscriber.

System_CAPS_pubpropertySubscriptionDBName

Gets or sets the name of the database on the Subscriber that receives the replicated data.

System_CAPS_pubpropertySubscriptionType

Gets whether the subscription registration is for a push or pull subscription.

System_CAPS_pubpropertySynchronizationAgentName

Gets or sets the name of the agent job created to synchronize the subscription.

System_CAPS_pubpropertySynchronizationAgentProcessSecurity

Gets the security context that is used to specify the Microsoft Windows account under which the synchronization agent job runs to synchronize the subscription.

System_CAPS_pubpropertySyncType

Gets or sets the manner in which the subscription is initialized.

System_CAPS_pubpropertyUserData

Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)

NameDescription
System_CAPS_protmethodCheckValidCreation()

This API supports the product infrastructure and is not intended to be used directly from your code. Checks the valid replication creation.(Inherited from ReplicationObject.)

System_CAPS_protmethodCheckValidDefinition(Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Indicates whether the subscription definition is valid.(Overrides ReplicationObject.CheckValidDefinition(Boolean).)

System_CAPS_pubmethodCommitPropertyChanges()

Sends all the cached property change statements to the instance of Microsoft SQL Server.(Inherited from ReplicationObject.)

System_CAPS_pubmethodCreate()

Creates the subscription registration at the Publisher.

System_CAPS_pubmethodDecouple()

Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_protmethodGetChangeCommand(StringBuilder, String, String)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the change command from the replication.(Inherited from ReplicationObject.)

System_CAPS_protmethodGetCreateCommand(StringBuilder, Boolean, ScriptOptions)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the create command from the replication.(Inherited from ReplicationObject.)

System_CAPS_protmethodGetDropCommand(StringBuilder, Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the drop command from the replication.(Inherited from ReplicationObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodInternalRefresh(Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Initiates an internal refresh from the replication.(Inherited from ReplicationObject.)

System_CAPS_pubmethodLoad()

Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodLoadProperties()

Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodRefresh()

Reloads the properties of the object. (Inherited from ReplicationObject.)

System_CAPS_pubmethodRemove()

Deletes the subscription registration at the Publisher and removes replication objects at the Subscriber for a push subscription.

System_CAPS_pubmethodScript(ScriptOptions)

Returns a Transact-SQL script that can be used to create or delete the subscription.

System_CAPS_pubmethodToString()

(Inherited from Object.)

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

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top

Community Additions

Show:
© 2015 Microsoft