PullSubscription Class

Represents information at the Publisher for a subscription to a merge or a transactional publication when the Synchronization Agent runs at the Subscriber. PullSubscription is a base class from which the TransPullSubscription class and the MergePullSubscription class are derived.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.PullSubscription
      Microsoft.SqlServer.Replication.MergePullSubscription
      Microsoft.SqlServer.Replication.TransPullSubscription

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

Syntax

'Declaration
<StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, PublicKey := "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8",  _
    Name := "Microsoft.SqlServer.Rmo")> _
Public MustInherit Class PullSubscription _
    Inherits ReplicationObject
'Usage
Dim instance As PullSubscription
[StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8", 
    Name = "Microsoft.SqlServer.Rmo")]
public abstract class PullSubscription : ReplicationObject
[StrongNameIdentityPermissionAttribute(SecurityAction::InheritanceDemand, PublicKey = L"0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8", 
    Name = L"Microsoft.SqlServer.Rmo")]
public ref class PullSubscription abstract : public ReplicationObject
[<AbstractClassAttribute>]
[<StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8", 
    Name = "Microsoft.SqlServer.Rmo")>]
type PullSubscription =  
    class 
        inherit ReplicationObject 
    end
public abstract class PullSubscription extends ReplicationObject

The PullSubscription type exposes the following members.

Constructors

  Name Description
Protected method PullSubscription Creates a new instance of the PullSubscription class.

Top

Properties

  Name Description
Public property AgentJobId Gets the ID of the agent job used to synchronize the subscription.
Public property AgentOffload Gets or sets whether or not 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.
Public property AgentOffloadServer Gets or sets the name of the remote computer where the agent runs when using remote agent activation.
Public property AgentSchedule Gets the schedule for the agent job used to synchronize the subscription.
Public property AltSnapshotFolder Gets or sets the location where the publication snapshot files are obtained when the default snapshot location at the Distributor is not used.
Public property CachePropertyChanges Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
Public property ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public property CreateSyncAgentByDefault Gets or sets whether or not the agent job used to start the Replication Agent to synchronize the subscription is created when the subscription is created.
Public property DatabaseName Gets or sets the name of the subscription database.
Public property Description Gets or sets a textual description of the pull subscription.
Public property DistributorName Gets or sets the instance of Microsoft SQL Server that is the Distributor and is distributing the publication to which the subscription subscribes.
Public property DistributorSecurity Gets the security context used to connect to the Distributor.
Public property EnabledForSynchronizationManager Specifies whether or not the subscription can be synchronized using Windows Synchronization Manager.
Public property FtpAddress Infrastructure. Gets or sets the IP address of the FTP server.
Public property FtpLogin Infrastructure. Gets or sets the FTP login.
Public property FtpPassword Infrastructure. Gets or sets the FTP password.
Public property FtpPort Infrastructure. Gets or sets the port number for the FTP server.
Public property IsExistingObject Gets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public property LastAgentDateTime Gets the date and time when the subscription was last synchronized.
Public property LastAgentStatus Gets the status of the most recent synchronization of the subscription.
Public property LastAgentSummary Gets a summary of the result of the most recent synchronization of the subscription.
Public property Name Gets the name generated for the pull subscription.
Public property PublicationDBName Gets or sets the name of the publication database.
Public property PublicationName Gets or sets the name of the publication to which the subscription subscribes.
Public property PublisherName Gets or sets the name of the Publisher.
Public property PublisherSecurity Gets or sets the security context used by the Synchronization Agent when connecting to the Publisher.
Public property SecureFtpPassword Infrastructure. Gets or sets the secured password for the login used to connect to the FTP server.
Public property SqlServerName Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public property SubscriberSecurity Gets the security context that is used by the Synchronization Agent when connecting to the Subscriber.
Public property SubscriptionId Gets the subscription ID value.
Public property SubscriptionType Gets whether the subscription registration is for a push, pull, or anonymous subscription.
Public property 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.
Public property Type Infrastructure. Gets or sets the publication type.
Public property UseFtp Gets or sets whether or not the snapshot files needed to initialize the pull subscription are accessed by the Synchronization Agent using File Transfer Protocol (FTP).
Public property UserData Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)
Public property WorkingDirectory Gets or sets the path of the directory at the Subscriber that is used to temporarily store and decompress downloaded snapshot files.

Top

Methods

  Name Description
Protected method CheckValidCreation Infrastructure. Checks the valid replication creation. (Inherited from ReplicationObject.)
Protected method CheckValidDefinition Infrastructure. Indicates whether the definition if valid. (Overrides ReplicationObject.CheckValidDefinition(Boolean).)
Public method CommitPropertyChanges Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public method Create Creates the pull subscription on the Subscriber.
Protected method CustomEnabledForSyncMgr Infrastructure. Enables the custom publication for synchronous manager.
Public method Decouple Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GetChangeCommand Infrastructure. Returns the change command from the replication. (Inherited from ReplicationObject.)
Protected method GetCreateCommand Infrastructure. Returns the create command from the replication. (Inherited from ReplicationObject.)
Protected method GetDropCommand Infrastructure. Returns the drop command from the replication. (Inherited from ReplicationObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method InitMemberVariables Infrastructure. Initializes the member variables.
Protected method InternalRefresh Infrastructure. Initiates an internal refresh from the replication. (Inherited from ReplicationObject.)
Public method LastAgentJobHistoryInfo Returns information on the last Synchronization Agent job that was run.
Public method Load Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public method LoadProperties Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Refresh Reloads the properties of the object. (Inherited from ReplicationObject.)
Public method Remove Removes the pull subscription.
Public method Script Returns a Transact-SQL script to create or delete the pull subscription based on the current property setting of the PullSubscription object.
Public method StopSynchronizationJob Attempts to stop a running job that is synchronizing the subscription.
Public method SynchronizeWithJob Starts the agent job to synchronize the subscription.
Public method ToString (Inherited from Object.)

Top

Remarks

The TransPullSubscription class and the MergePullSubscription class are used to create pull subscriptions at the Subscriber. You must also use the TransSubscription class and the MergeSubscription class to register the pull subscription at the Publisher.

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.

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Replication Namespace