PullSubscription Members

  • Article

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 following tables list the members exposed by the PullSubscription type.

Protected Constructors

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

Top

Public Properties

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

Top

Public Methods

(see also Protected Methods )

  Name Description
ms158272.pubmethod(en-US,SQL.90).gif CommitPropertyChanges  Sends all the cached property change statements to the instance of Microsoft SQL Server. (inherited from ReplicationObject)
ms158272.pubmethod(en-US,SQL.90).gif Create Creates the pull subscription on the Subscriber.
ms158272.pubmethod(en-US,SQL.90).gif Decouple  Decouples the referenced replication object from the server. (inherited from ReplicationObject)
ms158272.pubmethod(en-US,SQL.90).gif Equals  Overloaded. (inherited from Object )
ms158272.pubmethod(en-US,SQL.90).gif GetHashCode  (inherited from Object )
ms158272.pubmethod(en-US,SQL.90).gif GetType  (inherited from Object )
ms158272.pubmethod(en-US,SQL.90).gif LastAgentJobHistoryInfo Returns information on the last Synchronization Agent job that was run.
ms158272.pubmethod(en-US,SQL.90).gif Load  Loads the properties of an existing object from the server. (inherited from ReplicationObject)
ms158272.pubmethod(en-US,SQL.90).gif LoadProperties  Loads the properties of an existing object from the server. (inherited from ReplicationObject)
ms158272.pubmethod(en-US,SQL.90).gifms158272.static(en-US,SQL.90).gif ReferenceEquals  (inherited from Object )
ms158272.pubmethod(en-US,SQL.90).gif Refresh  Reloads the properties of the object. (inherited from ReplicationObject)
ms158272.pubmethod(en-US,SQL.90).gif Remove Removes the pull subscription.
ms158272.pubmethod(en-US,SQL.90).gif Script Returns a Transact-SQL script to create or delete the pull subscription based on the current property setting of the PullSubscription object.
ms158272.pubmethod(en-US,SQL.90).gif StopSynchronizationJob Attempts to stop a running job that is synchronizing the subscription.
ms158272.pubmethod(en-US,SQL.90).gif SynchronizeWithJob Starts the agent job to synchronize the subscription.
ms158272.pubmethod(en-US,SQL.90).gif ToString  (inherited from Object )

Top

Protected Methods

  Name Description
ms158272.protmethod(en-US,SQL.90).gif CheckValidCreation  (inherited from ReplicationObject )
ms158272.protmethod(en-US,SQL.90).gif CheckValidDefinition Overridden.  
ms158272.protmethod(en-US,SQL.90).gif CustomEnabledForSyncMgr  
ms158272.protmethod(en-US,SQL.90).gif Finalize  (inherited from Object )
ms158272.protmethod(en-US,SQL.90).gif GetChangeCommand  (inherited from ReplicationObject )
ms158272.protmethod(en-US,SQL.90).gif GetCreateCommand  (inherited from ReplicationObject )
ms158272.protmethod(en-US,SQL.90).gif GetDropCommand  (inherited from ReplicationObject )
ms158272.protmethod(en-US,SQL.90).gif InitMemberVariables  
ms158272.protmethod(en-US,SQL.90).gif InternalRefresh  (inherited from ReplicationObject )
ms158272.protmethod(en-US,SQL.90).gif MemberwiseClone  (inherited from Object )

Top

See Also

Reference

PullSubscription Class
Microsoft.SqlServer.Replication Namespace