Export (0) Print
Expand All

DistributionSubscription Class

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

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

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

public sealed class DistributionSubscription : ReplicationObject

The DistributionSubscription type exposes the following members.

  NameDescription
Public methodDistributionSubscription()Creates a new instance of the DistributionSubscription class.
Public methodDistributionSubscription(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

  NameDescription
Public propertyAgentJobIdGets the ID of the SQL Server Agent job that synchronizes the Subscription.
Public propertyAgentScheduleGets the synchronization agent schedule for the subscription.
Public propertyCachePropertyChangesGets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
Public propertyConnectionContextGets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public propertyDistributionAgentGets the name of the SQL Server Agent job that is used to synchronize the subscription.
Public propertyDistributionDBNameGets or sets the name of the distribution database.
Public propertyIsExistingObjectGets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public propertyNameGets the name of the subscription.
Public propertyPublicationDBNameGets or sets the name of the publication database.
Public propertyPublicationNameGets or sets the name of the publication to which the subscription belongs.
Public propertyPublisherNameGets or sets the Publisher of the publication to which the subscription belongs.
Public propertySqlServerNameGets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public propertyStatusGets or sets the status of the subscription.
Public propertySubscriberNameGets or sets the name of the Subscriber.
Public propertySubscriptionDBNameGets or sets the name of the subscription database.
Public propertySubscriptionTypeGets or sets whether the Distribution agent runs at the Distributor (Push) or at the Subscriber (Pull).
Public propertySyncTypeGets or sets the manner in which the subscription is initialized.
Public propertyUserDataGets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)
Top

  NameDescription
Public methodCommitPropertyChangesSends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public methodDecoupleDecouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodLoadLoads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public methodLoadPropertiesLoads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public methodRefreshReloads the properties of the object. (Inherited from ReplicationObject.)
Public methodScriptInfrastructure. Generates a Transact-SQL script for the subscription.
Public methodToString (Inherited from Object.)
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft