MergePullSubscription MergePullSubscription MergePullSubscription Class

Definition

Represents a pull subscription to a merge publication.

public ref class MergePullSubscription sealed : Microsoft::SqlServer::Replication::PullSubscription
public sealed class MergePullSubscription : Microsoft.SqlServer.Replication.PullSubscription
Public NotInheritable Class MergePullSubscription
Inherits PullSubscription
Inheritance

Examples

// Define the Publisher, publication, and databases.
string publicationName = "AdvWorksSalesOrdersMerge";
string publisherName = publisherInstance;
string subscriberName = subscriberInstance;
string subscriptionDbName = "AdventureWorks2012Replica";
string publicationDbName = "AdventureWorks2012";
string hostname = @"adventure-works\garrett1";

//Create connections to the Publisher and Subscriber.
ServerConnection subscriberConn = new ServerConnection(subscriberName);
ServerConnection publisherConn = new ServerConnection(publisherName);

// Create the objects that we need.
MergePublication publication;
MergePullSubscription subscription;

try
{
	// Connect to the Subscriber.
	subscriberConn.Connect();

	// Ensure that the publication exists and that 
	// it supports pull subscriptions.
	publication = new MergePublication();
	publication.Name = publicationName;
	publication.DatabaseName = publicationDbName;
	publication.ConnectionContext = publisherConn;

	if (publication.LoadProperties())
	{
		if ((publication.Attributes & PublicationAttributes.AllowPull) == 0)
		{
			publication.Attributes |= PublicationAttributes.AllowPull;
		}

		// Define the pull subscription.
		subscription = new MergePullSubscription();
		subscription.ConnectionContext = subscriberConn;
		subscription.PublisherName = publisherName;
		subscription.PublicationName = publicationName;
		subscription.PublicationDBName = publicationDbName;
		subscription.DatabaseName = subscriptionDbName;
		subscription.HostName = hostname;

		// Specify the Windows login credentials for the Merge Agent job.
		subscription.SynchronizationAgentProcessSecurity.Login = winLogin;
		subscription.SynchronizationAgentProcessSecurity.Password = winPassword;

		// Make sure that the agent job for the subscription is created.
		subscription.CreateSyncAgentByDefault = true;

		// Create the pull subscription at the Subscriber.
		subscription.Create();

		Boolean registered = false;

		// Verify that the subscription is not already registered.
		foreach (MergeSubscription existing
			in publication.EnumSubscriptions())
		{
			if (existing.SubscriberName == subscriberName
				&& existing.SubscriptionDBName == subscriptionDbName
				&& existing.SubscriptionType == SubscriptionOption.Pull)
			{
				registered = true;
			}
		}
		if (!registered)
		{
			// Register the local subscription with the Publisher.
			publication.MakePullSubscriptionWellKnown(
				subscriberName, subscriptionDbName,
				SubscriptionSyncType.Automatic,
				MergeSubscriberType.Local, 0);
		}
	}
	else
	{
		// Do something here if the publication does not exist.
		throw new ApplicationException(String.Format(
			"The publication '{0}' does not exist on {1}.",
			publicationName, publisherName));
	}
}
catch (Exception ex)
{
	// Implement the appropriate error handling here.
	throw new ApplicationException(String.Format(
		"The subscription to {0} could not be created.", publicationName), ex);
}
finally
{
	subscriberConn.Disconnect();
	publisherConn.Disconnect();
}
' Define the Publisher, publication, and databases.
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim publisherName As String = publisherInstance
Dim subscriberName As String = subscriberInstance
Dim subscriptionDbName As String = "AdventureWorks2012Replica"
Dim publicationDbName As String = "AdventureWorks2012"
Dim hostname As String = "adventure-works\garrett1"

'Create connections to the Publisher and Subscriber.
Dim subscriberConn As ServerConnection = New ServerConnection(subscriberName)
Dim publisherConn As ServerConnection = New ServerConnection(publisherName)

' Create the objects that we need.
Dim publication As MergePublication
Dim subscription As MergePullSubscription

Try
    ' Connect to the Subscriber.
    subscriberConn.Connect()

    ' Ensure that the publication exists and that 
    ' it supports pull subscriptions.
    publication = New MergePublication()
    publication.Name = publicationName
    publication.DatabaseName = publicationDbName
    publication.ConnectionContext = publisherConn

    If publication.LoadProperties() Then
        If (publication.Attributes And PublicationAttributes.AllowPull) = 0 Then
            publication.Attributes = publication.Attributes _
            Or PublicationAttributes.AllowPull
        End If

        ' Define the pull subscription.
        subscription = New MergePullSubscription()
        subscription.ConnectionContext = subscriberConn
        subscription.PublisherName = publisherName
        subscription.PublicationName = publicationName
        subscription.PublicationDBName = publicationDbName
        subscription.DatabaseName = subscriptionDbName
        subscription.HostName = hostname

        ' Specify the Windows login credentials for the Merge Agent job.
        subscription.SynchronizationAgentProcessSecurity.Login = winLogin
        subscription.SynchronizationAgentProcessSecurity.Password = winPassword

        ' Make sure that the agent job for the subscription is created.
        subscription.CreateSyncAgentByDefault = True

        ' Create the pull subscription at the Subscriber.
        subscription.Create()

        Dim registered As Boolean = False

        ' Verify that the subscription is not already registered.
        For Each existing As MergeSubscription In _
        publication.EnumSubscriptions()
            If existing.SubscriberName = subscriberName Then
                registered = True
            End If
        Next
        If Not registered Then
            ' Register the local subscription with the Publisher.
            publication.MakePullSubscriptionWellKnown( _
             subscriberName, subscriptionDbName, _
             SubscriptionSyncType.Automatic, _
             MergeSubscriberType.Local, 0)
        End If
    Else
        ' Do something here if the publication does not exist.
        Throw New ApplicationException(String.Format( _
         "The publication '{0}' does not exist on {1}.", _
         publicationName, publisherName))
    End If
Catch ex As Exception
    ' Implement the appropriate error handling here.
    Throw New ApplicationException(String.Format( _
        "The subscription to {0} could not be created.", publicationName), ex)
Finally
    subscriberConn.Disconnect()
    publisherConn.Disconnect()
End Try

Remarks

For a pull subscription, the Merge Agent runs at the Subscriber.

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.

Constructors

MergePullSubscription() MergePullSubscription() MergePullSubscription()

Creates a new instance of the MergePullSubscription class.

MergePullSubscription(String, String, String, String, ServerConnection) MergePullSubscription(String, String, String, String, ServerConnection) MergePullSubscription(String, String, String, String, ServerConnection)

Initializes a new instance of the MergePullSubscription class with the specified database, Publisher, publication, and Subscriber connection.

MergePullSubscription(String, String, String, String, ServerConnection, Boolean) MergePullSubscription(String, String, String, String, ServerConnection, Boolean) MergePullSubscription(String, String, String, String, ServerConnection, Boolean)

Creates a new instance of the MergePullSubscription class with the specified database, Publisher, publication, Subscriber connection, and whether the agent job is created.

Properties

AgentJobId AgentJobId AgentJobId

Gets the ID of the agent job used to synchronize the subscription.

(Inherited from PullSubscription)
AgentOffload AgentOffload 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.

(Inherited from PullSubscription)
AgentOffloadServer AgentOffloadServer AgentOffloadServer

Gets or sets the name of the remote computer where the agent runs when using remote agent activation.

(Inherited from PullSubscription)
AgentSchedule AgentSchedule AgentSchedule

Gets the schedule for the agent job used to synchronize the subscription.

(Inherited from PullSubscription)
AltSnapshotFolder AltSnapshotFolder AltSnapshotFolder

Gets or sets the location where the publication snapshot files are obtained when the default snapshot location at the Distributor is not used.

(Inherited from PullSubscription)
CachePropertyChanges CachePropertyChanges CachePropertyChanges

Gets or sets whether to cache changes made to the replication properties or to apply them immediately.

(Inherited from ReplicationObject)
ConnectionContext ConnectionContext ConnectionContext

Gets or sets the connection to an instance of Microsoft SQL Server.

(Inherited from ReplicationObject)
CreateSyncAgentByDefault CreateSyncAgentByDefault 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.

(Inherited from PullSubscription)
DatabaseName DatabaseName DatabaseName

Gets or sets the name of the subscription database.

(Inherited from PullSubscription)
Description Description Description

Gets or sets a textual description of the pull subscription.

(Inherited from PullSubscription)
DistributorName DistributorName DistributorName

Gets or sets the instance of Microsoft SQL Server that is the Distributor and is distributing the publication to which the subscription subscribes.

(Inherited from PullSubscription)
DistributorSecurity DistributorSecurity DistributorSecurity

Gets the security context used to connect to the Distributor.

(Inherited from PullSubscription)
DynamicSnapshotLocation DynamicSnapshotLocation DynamicSnapshotLocation

Gets or sets the file location for the subscription-specific snapshot files when the publication uses a parameterized row filter.

EnabledForSynchronizationManager EnabledForSynchronizationManager EnabledForSynchronizationManager

Specifies whether or not the subscription can be synchronized using Windows Synchronization Manager.

(Inherited from PullSubscription)
FtpAddress FtpAddress FtpAddress

Gets or sets the IP address of the FTP server.

(Inherited from PullSubscription)
FtpLogin FtpLogin FtpLogin

Gets or sets the FTP login.

(Inherited from PullSubscription)
FtpPassword FtpPassword FtpPassword

Gets or sets the FTP password.

(Inherited from PullSubscription)
FtpPort FtpPort FtpPort

Gets or sets the port number for the FTP server.

(Inherited from PullSubscription)
HostName HostName HostName

Gets or sets the value supplied to the HOST_NAME function when this function is used in the parameterized row filter that defines the Subscriber's data partition.

InternetLogin InternetLogin InternetLogin

Gets or sets the login used with HTTP Basic Authentication when connecting to the Web server during Web synchronization.

InternetPassword InternetPassword InternetPassword

Gets or sets the password for the supplied InternetLogin value when connecting to the Web server during Web synchronization.

InternetSecurityMode InternetSecurityMode InternetSecurityMode

Gets or sets the HTTP authentication method used when connecting to the Web server during Web synchronization.

InternetTimeout InternetTimeout InternetTimeout

Gets or sets the HTTP timeout, in seconds, when connecting to the Web server during Web synchronization.

InternetUrl InternetUrl InternetUrl

Gets or sets the URL to use when synchronizing the subscription using Web synchronization.

IsExistingObject IsExistingObject IsExistingObject

Gets whether the object exists on the server or not.

(Inherited from ReplicationObject)
IsMemoryOptimized IsMemoryOptimized IsMemoryOptimized Inherited from PullSubscription
LastAgentDateTime LastAgentDateTime LastAgentDateTime

Gets the date and time when the subscription was last synchronized.

(Inherited from PullSubscription)
LastAgentStatus LastAgentStatus LastAgentStatus

Gets the status of the most recent synchronization of the subscription.

(Inherited from PullSubscription)
LastAgentSummary LastAgentSummary LastAgentSummary

Gets a summary of the result of the most recent synchronization of the subscription.

(Inherited from PullSubscription)
Name Name Name

Gets the name generated for the pull subscription.

(Inherited from PullSubscription)
Priority Priority Priority

Gets or sets the weighting of this server subscription relative to other server subscriptions when resolving conflicts between subscriptions.

PublicationDBName PublicationDBName PublicationDBName

Gets or sets the name of the publication database.

(Inherited from PullSubscription)
PublicationName PublicationName PublicationName

Gets or sets the name of the publication to which the subscription subscribes.

(Inherited from PullSubscription)
PublisherName PublisherName PublisherName

Gets or sets the name of the Publisher.

(Inherited from PullSubscription)
PublisherSecurity PublisherSecurity PublisherSecurity

Gets or sets the security context used by the Synchronization Agent when connecting to the Publisher.

(Inherited from PullSubscription)
SecureFtpPassword SecureFtpPassword SecureFtpPassword

Gets or sets the secured password for the login used to connect to the FTP server.

(Inherited from PullSubscription)
SecureInternetPassword SecureInternetPassword SecureInternetPassword

Sets the password (as a SecureString object) used when connecting to the Web server using HTTP Basic Authentication.

SqlServerName SqlServerName SqlServerName

Gets the name of the Microsoft SQL Server instance to which this object is connected.

(Inherited from ReplicationObject)
SubscriberSecurity SubscriberSecurity SubscriberSecurity

Gets the security context that is used by the Synchronization Agent when connecting to the Subscriber.

(Inherited from PullSubscription)
SubscriberType SubscriberType SubscriberType

Gets or sets whether the subscription is a server or client subscription.

SubscriptionId SubscriptionId SubscriptionId

Gets the subscription ID value.

(Inherited from PullSubscription)
SubscriptionType SubscriptionType SubscriptionType

Gets whether the subscription registration is for a push, pull, or anonymous subscription.

(Inherited from PullSubscription)
SynchronizationAgent SynchronizationAgent SynchronizationAgent

Gets an object that represents an instance of the Merge Agent that can be used to synchronize the subscription.

SynchronizationAgentProcessSecurity SynchronizationAgentProcessSecurity 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.

(Inherited from PullSubscription)
SyncType SyncType SyncType

Gets or sets the manner in which data is initialized at the Subscriber.

Type Type Type

Gets or sets the publication type.

(Inherited from PullSubscription)
UseFtp UseFtp 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).

(Inherited from PullSubscription)
UseInteractiveResolver UseInteractiveResolver UseInteractiveResolver

Gets or sets whether the Interactive Resolver is used during the synchronization process.

UserData UserData UserData

Gets or sets an object property that allows users to attach their own data to the object.

(Inherited from ReplicationObject)
UseWebSynchronization UseWebSynchronization UseWebSynchronization

Gets or sets whether the subscription is synchronized using Web synchronization.

WorkingDirectory WorkingDirectory WorkingDirectory

Gets or sets the path of the directory at the Subscriber that is used to temporarily store and decompress downloaded snapshot files.

(Inherited from PullSubscription)

Methods

CheckValidCreation() CheckValidCreation() CheckValidCreation()

Checks the valid replication creation.

(Inherited from ReplicationObject)
CheckValidDefinition(Boolean) CheckValidDefinition(Boolean) CheckValidDefinition(Boolean)

Indicates whether the definition if valid.

(Inherited from PullSubscription)
CommitPropertyChanges() CommitPropertyChanges() CommitPropertyChanges()

Sends all the cached property change statements to the instance of Microsoft SQL Server.

(Inherited from ReplicationObject)
Create() Create() Create()

Creates the pull subscription on the Subscriber.

(Inherited from PullSubscription)
CustomEnabledForSyncMgr(StringBuilder) CustomEnabledForSyncMgr(StringBuilder) CustomEnabledForSyncMgr(StringBuilder)

Enables the custom publication for synchronous manager.

(Inherited from PullSubscription)
Decouple() Decouple() Decouple()

Decouples the referenced replication object from the server.

(Inherited from ReplicationObject)
EnumSynchronizationPartners() EnumSynchronizationPartners() EnumSynchronizationPartners()

Returns the Alternate Synchronization Partners

GetChangeCommand(StringBuilder, String, String) GetChangeCommand(StringBuilder, String, String) GetChangeCommand(StringBuilder, String, String)

Returns the change command from the replication.

(Inherited from ReplicationObject)
GetCreateCommand(StringBuilder, Boolean, ScriptOptions) GetCreateCommand(StringBuilder, Boolean, ScriptOptions) GetCreateCommand(StringBuilder, Boolean, ScriptOptions)

Returns the create command from the replication.

(Inherited from ReplicationObject)
GetDropCommand(StringBuilder, Boolean) GetDropCommand(StringBuilder, Boolean) GetDropCommand(StringBuilder, Boolean)

Returns the drop command from the replication.

(Inherited from ReplicationObject)
InitMemberVariables(String, String, String, String, Boolean) InitMemberVariables(String, String, String, String, Boolean) InitMemberVariables(String, String, String, String, Boolean)

Initializes the member variables.

(Inherited from PullSubscription)
InternalRefresh(Boolean) InternalRefresh(Boolean) InternalRefresh(Boolean)

Initiates an internal refresh from the replication.

(Inherited from ReplicationObject)
LastAgentJobHistoryInfo() LastAgentJobHistoryInfo() LastAgentJobHistoryInfo()

Returns information on the last Synchronization Agent job that was run.

(Inherited from PullSubscription)
Load() Load() Load()

Loads the properties of an existing object from the server.

(Inherited from ReplicationObject)
LoadProperties() LoadProperties() LoadProperties()

Loads the properties of an existing object from the server.

(Inherited from ReplicationObject)
Refresh() Refresh() Refresh()

Reloads the properties of the object.

(Inherited from ReplicationObject)
Reinitialize(Boolean) Reinitialize(Boolean) Reinitialize(Boolean)

Marks the merge pull subscription for reinitialization.

Remove() Remove() Remove()

Removes the pull subscription.

(Inherited from PullSubscription)
Script(ScriptOptions) Script(ScriptOptions) Script(ScriptOptions)

Returns a Transact-SQL script to create or delete the pull subscription based on the current property setting of the PullSubscription object.

(Inherited from PullSubscription)
StopSynchronizationJob() StopSynchronizationJob() StopSynchronizationJob()

Attempts to stop a running Merge Agent job that is currently synchronizing the subscription.

SynchronizeWithJob() SynchronizeWithJob() SynchronizeWithJob()

Starts the agent job asynchronously to synchronize the pull subscription.

Applies to

See Also