Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

DistributionSubscription Class

 

Applies To: SQL Server 2016 Preview

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

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

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

public sealed class DistributionSubscription : ReplicationObject

NameDescription
System_CAPS_pubmethodDistributionSubscription()

Creates a new instance of the DistributionSubscription class.

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

NameDescription
System_CAPS_pubpropertyAgentJobId

Gets the ID of the SQL Server Agent job that synchronizes the Subscription.

System_CAPS_pubpropertyAgentSchedule

Gets the synchronization agent schedule for 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_pubpropertyDistributionAgent

Gets the name of the SQL Server Agent job that is used to synchronize the subscription.

System_CAPS_pubpropertyDistributionDBName

Gets or sets the name of the distribution database.

System_CAPS_pubpropertyIsExistingObject

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

System_CAPS_pubpropertyName

Gets the name of the subscription.

System_CAPS_pubpropertyPublicationDBName

Gets or sets the name of the publication database.

System_CAPS_pubpropertyPublicationName

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

System_CAPS_pubpropertyPublisherName

Gets or sets the Publisher of the publication to which the subscription belongs.

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 or sets the status of the subscription.

System_CAPS_pubpropertySubscriberName

Gets or sets the name of the Subscriber.

System_CAPS_pubpropertySubscriptionDBName

Gets or sets the name of the subscription database.

System_CAPS_pubpropertySubscriptionType

Gets or sets whether the Distribution agent runs at the Distributor (Push) or at the Subscriber (Pull).

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_pubmethodCommitPropertyChanges()

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

System_CAPS_pubmethodDecouple()

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

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

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_pubmethodRefresh()

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

System_CAPS_pubmethodScript(ScriptOptions)

This API supports the product infrastructure and is not intended to be used directly from your code. Generates a Transact-SQL script for the subscription.

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

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