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 | |
|---|---|---|
.gif "Protected method") |
PullSubscription | Creates a new instance of the PullSubscription class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AgentJobId | Gets the ID of the agent job used to synchronize the subscription. |
|
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. |
|
AgentOffloadServer | Gets or sets the name of the remote computer where the agent runs when using remote agent activation. |
|
AgentSchedule | Gets the schedule for the agent job used to synchronize the subscription. |
|
AltSnapshotFolder | Gets or sets the location where the publication snapshot files are obtained when the default snapshot location at the Distributor is not used. |
|
CachePropertyChanges | Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.) |
|
ConnectionContext | Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.) |
|
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. |
|
DatabaseName | Gets or sets the name of the subscription database. |
|
Description | Gets or sets a textual description of the pull subscription. |
|
DistributorName | Gets or sets the instance of Microsoft SQL Server that is the Distributor and is distributing the publication to which the subscription subscribes. |
|
DistributorSecurity | Gets the security context used to connect to the Distributor. |
|
EnabledForSynchronizationManager | Specifies whether or not the subscription can be synchronized using Windows Synchronization Manager. |
|
FtpAddress | Infrastructure. Gets or sets the IP address of the FTP server. |
|
FtpLogin | Infrastructure. Gets or sets the FTP login. |
|
FtpPassword | Infrastructure. Gets or sets the FTP password. |
|
FtpPort | Infrastructure. Gets or sets the port number for the FTP server. |
|
IsExistingObject | Gets whether the object exists on the server or not. (Inherited from ReplicationObject.) |
|
LastAgentDateTime | Gets the date and time when the subscription was last synchronized. |
|
LastAgentStatus | Gets the status of the most recent synchronization of the subscription. |
|
LastAgentSummary | Gets a summary of the result of the most recent synchronization of the subscription. |
|
Name | Gets the name generated for the pull subscription. |
|
PublicationDBName | Gets or sets the name of the publication database. |
|
PublicationName | Gets or sets the name of the publication to which the subscription subscribes. |
|
PublisherName | Gets or sets the name of the Publisher. |
|
PublisherSecurity | Gets or sets the security context used by the Synchronization Agent when connecting to the Publisher. |
|
SecureFtpPassword | Infrastructure. Gets or sets the secured password for the login used to connect to the FTP server. |
|
SqlServerName | Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.) |
|
SubscriberSecurity | Gets the security context that is used by the Synchronization Agent when connecting to the Subscriber. |
|
SubscriptionId | Gets the subscription ID value. |
|
SubscriptionType | Gets whether the subscription registration is for a push, pull, or anonymous subscription. |
|
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. |
|
Type | Infrastructure. Gets or sets the publication type. |
|
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). |
|
UserData | Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.) |
|
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 | |
|---|---|---|
|
CheckValidCreation | Infrastructure. Checks the valid replication creation. (Inherited from ReplicationObject.) |
|
CheckValidDefinition | Infrastructure. Indicates whether the definition if valid. (Overrides ReplicationObject.CheckValidDefinition(Boolean).) |
.gif "Public method") |
CommitPropertyChanges | Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.) |
|
Create | Creates the pull subscription on the Subscriber. |
|
CustomEnabledForSyncMgr | Infrastructure. Enables the custom publication for synchronous manager. |
|
Decouple | Decouples the referenced replication object from the server. (Inherited from ReplicationObject.) |
|
Equals | (Inherited from Object.) |
|
Finalize | (Inherited from Object.) |
|
GetChangeCommand | Infrastructure. Returns the change command from the replication. (Inherited from ReplicationObject.) |
|
GetCreateCommand | Infrastructure. Returns the create command from the replication. (Inherited from ReplicationObject.) |
|
GetDropCommand | Infrastructure. Returns the drop command from the replication. (Inherited from ReplicationObject.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
InitMemberVariables | Infrastructure. Initializes the member variables. |
|
InternalRefresh | Infrastructure. Initiates an internal refresh from the replication. (Inherited from ReplicationObject.) |
|
LastAgentJobHistoryInfo | Returns information on the last Synchronization Agent job that was run. |
|
Load | Loads the properties of an existing object from the server. (Inherited from ReplicationObject.) |
|
LoadProperties | Loads the properties of an existing object from the server. (Inherited from ReplicationObject.) |
|
MemberwiseClone | (Inherited from Object.) |
|
Refresh | Reloads the properties of the object. (Inherited from ReplicationObject.) |
|
Remove | Removes the pull subscription. |
|
Script | Returns a Transact-SQL script to create or delete the pull subscription based on the current property setting of the PullSubscription object. |
|
StopSynchronizationJob | Attempts to stop a running job that is synchronizing the subscription. |
|
SynchronizeWithJob | Starts the agent job to synchronize the subscription. |
|
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.