Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)
[StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8", 
	Name = "Microsoft.SqlServer.Rmo")]
public abstract class PullSubscription : ReplicationObject

The PullSubscription type exposes the following members.

  NameDescription
Protected methodPullSubscriptionCreates a new instance of the PullSubscription class.
Top
  NameDescription
Public propertyAgentJobIdGets the ID of the agent job used to synchronize the subscription.
Public propertyAgentOffloadGets 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 propertyAgentOffloadServerGets or sets the name of the remote computer where the agent runs when using remote agent activation.
Public propertyAgentScheduleGets the schedule for the agent job used to synchronize the subscription.
Public propertyAltSnapshotFolderGets or sets the location where the publication snapshot files are obtained when the default snapshot location at the Distributor is not used.
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 propertyCreateSyncAgentByDefaultGets 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 propertyDatabaseNameGets or sets the name of the subscription database.
Public propertyDescriptionGets or sets a textual description of the pull subscription.
Public propertyDistributorNameGets or sets the instance of Microsoft SQL Server that is the Distributor and is distributing the publication to which the subscription subscribes.
Public propertyDistributorSecurityGets the security context used to connect to the Distributor.
Public propertyEnabledForSynchronizationManagerSpecifies whether or not the subscription can be synchronized using Windows Synchronization Manager.
Public propertyFtpAddressInfrastructure. Gets or sets the IP address of the FTP server.
Public propertyFtpLoginInfrastructure. Gets or sets the FTP login.
Public propertyFtpPasswordInfrastructure. Gets or sets the FTP password.
Public propertyFtpPortInfrastructure. Gets or sets the port number for the FTP server.
Public propertyIsExistingObjectGets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public propertyLastAgentDateTimeGets the date and time when the subscription was last synchronized.
Public propertyLastAgentStatusGets the status of the most recent synchronization of the subscription.
Public propertyLastAgentSummaryGets a summary of the result of the most recent synchronization of the subscription.
Public propertyNameGets the name generated for the pull subscription.
Public propertyPublicationDBNameGets or sets the name of the publication database.
Public propertyPublicationNameGets or sets the name of the publication to which the subscription subscribes.
Public propertyPublisherNameGets or sets the name of the Publisher.
Public propertyPublisherSecurityGets or sets the security context used by the Synchronization Agent when connecting to the Publisher.
Public propertySecureFtpPasswordInfrastructure. Gets or sets the secured password for the login used to connect to the FTP server.
Public propertySqlServerNameGets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public propertySubscriberSecurityGets the security context that is used by the Synchronization Agent when connecting to the Subscriber.
Public propertySubscriptionIdGets the subscription ID value.
Public propertySubscriptionTypeGets whether the subscription registration is for a push, pull, or anonymous subscription.
Public propertySynchronizationAgentProcessSecurityGets the security context that is used to specify the Microsoft Windows account under which the Synchronization Agent job runs to synchronize the subscription.
Public propertyTypeInfrastructure. Gets or sets the publication type.
Public propertyUseFtpGets 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 propertyUserDataGets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)
Public propertyWorkingDirectoryGets or sets the path of the directory at the Subscriber that is used to temporarily store and decompress downloaded snapshot files.
Top
  NameDescription
Protected methodCheckValidCreationInfrastructure. Checks the valid replication creation. (Inherited from ReplicationObject.)
Protected methodCheckValidDefinitionInfrastructure. Indicates whether the definition if valid. (Overrides ReplicationObject.CheckValidDefinition(Boolean).)
Public methodCommitPropertyChangesSends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public methodCreateCreates the pull subscription on the Subscriber.
Protected methodCustomEnabledForSyncMgrInfrastructure. Enables the custom publication for synchronous manager.
Public methodDecoupleDecouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Protected methodGetChangeCommandInfrastructure. Returns the change command from the replication. (Inherited from ReplicationObject.)
Protected methodGetCreateCommandInfrastructure. Returns the create command from the replication. (Inherited from ReplicationObject.)
Protected methodGetDropCommandInfrastructure. Returns the drop command from the replication. (Inherited from ReplicationObject.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodInitMemberVariablesInfrastructure. Initializes the member variables.
Protected methodInternalRefreshInfrastructure. Initiates an internal refresh from the replication. (Inherited from ReplicationObject.)
Public methodLastAgentJobHistoryInfoReturns information on the last Synchronization Agent job that was run.
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.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodRefreshReloads the properties of the object. (Inherited from ReplicationObject.)
Public methodRemoveRemoves the pull subscription.
Public methodScriptReturns a Transact-SQL script to create or delete the pull subscription based on the current property setting of the PullSubscription object.
Public methodStopSynchronizationJobAttempts to stop a running job that is synchronizing the subscription.
Public methodSynchronizeWithJobStarts the agent job to synchronize the subscription.
Public methodToString (Inherited from Object.)
Top

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.

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

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.