PullSubscription Members

Include Protected Members
Include Inherited Members

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.

The PullSubscription type exposes the following members.

Constructors

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

Top

Methods

  Name Description
Protected method CheckValidCreation() Infrastructure. (Inherited from ReplicationObject.)
Protected method CheckValidDefinition(Boolean) Infrastructure. (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(StringBuilder) Infrastructure.
Public method Decouple() Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public method Equals(Object) (Inherited from Object.)
Protected method Finalize() (Inherited from Object.)
Protected method GetChangeCommand(StringBuilder, String, String) Infrastructure. (Inherited from ReplicationObject.)
Protected method GetCreateCommand(StringBuilder, Boolean, ScriptOptions) Infrastructure. (Inherited from ReplicationObject.)
Protected method GetDropCommand(StringBuilder, Boolean) Infrastructure. (Inherited from ReplicationObject.)
Public method GetHashCode() (Inherited from Object.)
Public method GetType() (Inherited from Object.)
Protected method InitMemberVariables(String, String, String, String, Boolean) Infrastructure.
Protected method InternalRefresh(Boolean) Infrastructure. (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(ScriptOptions) 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

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.
Public property FtpLogin Infrastructure.
Public property FtpPassword Infrastructure.
Public property FtpPort Infrastructure.
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.
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.
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