Export (0) Print
Expand All

MergePullSubscription Class

Represents a pull subscription to a merge publication.

Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.PullSubscription
      Microsoft.SqlServer.Replication.MergePullSubscription

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

public sealed class MergePullSubscription : PullSubscription

The MergePullSubscription type exposes the following members.

  NameDescription
Public methodMergePullSubscription()Creates a new instance of the MergePullSubscription class.
Public methodMergePullSubscription(String, String, String, String, ServerConnection)Creates a new instance of the MergePullSubscription class with the specified database, Publisher, publication, and Subscriber connection.
Public methodMergePullSubscription(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.
Top

  NameDescription
Public propertyAgentJobIdGets the ID of the agent job used to synchronize the subscription. (Inherited from PullSubscription.)
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. (Inherited from PullSubscription.)
Public propertyAgentOffloadServerGets or sets the name of the remote computer where the agent runs when using remote agent activation. (Inherited from PullSubscription.)
Public propertyAgentScheduleGets the schedule for the agent job used to synchronize the subscription. (Inherited from PullSubscription.)
Public propertyAltSnapshotFolderGets 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.)
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. (Inherited from PullSubscription.)
Public propertyDatabaseNameGets or sets the name of the subscription database. (Inherited from PullSubscription.)
Public propertyDescriptionGets or sets a textual description of the pull subscription. (Inherited from PullSubscription.)
Public propertyDistributorNameGets 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.)
Public propertyDistributorSecurityGets the security context used to connect to the Distributor. (Inherited from PullSubscription.)
Public propertyDynamicSnapshotLocationGets or sets the file location for the subscription-specific snapshot files when the publication uses a parameterized row filter.
Public propertyEnabledForSynchronizationManagerSpecifies whether or not the subscription can be synchronized using Windows Synchronization Manager. (Inherited from PullSubscription.)
Public propertyFtpAddressInfrastructure. Gets or sets the IP address of the FTP server. (Inherited from PullSubscription.)
Public propertyFtpLoginInfrastructure. Gets or sets the FTP login. (Inherited from PullSubscription.)
Public propertyFtpPasswordInfrastructure. Gets or sets the FTP password. (Inherited from PullSubscription.)
Public propertyFtpPortInfrastructure. Gets or sets the port number for the FTP server. (Inherited from PullSubscription.)
Public propertyHostNameGets 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.
Public propertyInternetLoginGets or sets the login used with HTTP Basic Authentication when connecting to the Web server during Web synchronization.
Public propertyInternetPasswordGets or sets the password for the supplied InternetLogin value when connecting to the Web server during Web synchronization.
Public propertyInternetSecurityModeGets or sets the HTTP authentication method used when connecting to the Web server during Web synchronization.
Public propertyInternetTimeoutGets or sets the HTTP timeout, in seconds, when connecting to the Web server during Web synchronization.
Public propertyInternetUrlGets or sets the URL to use when synchronizing the subscription using Web synchronization.
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. (Inherited from PullSubscription.)
Public propertyLastAgentStatusGets the status of the most recent synchronization of the subscription. (Inherited from PullSubscription.)
Public propertyLastAgentSummaryGets a summary of the result of the most recent synchronization of the subscription. (Inherited from PullSubscription.)
Public propertyNameGets the name generated for the pull subscription. (Inherited from PullSubscription.)
Public propertyPriorityGets or sets the weighting of this server subscription relative to other server subscriptions when resolving conflicts between subscriptions.
Public propertyPublicationDBNameGets or sets the name of the publication database. (Inherited from PullSubscription.)
Public propertyPublicationNameGets or sets the name of the publication to which the subscription subscribes. (Inherited from PullSubscription.)
Public propertyPublisherNameGets or sets the name of the Publisher. (Inherited from PullSubscription.)
Public propertyPublisherSecurityGets or sets the security context used by the Synchronization Agent when connecting to the Publisher. (Inherited from PullSubscription.)
Public propertySecureFtpPasswordInfrastructure. Gets or sets the secured password for the login used to connect to the FTP server. (Inherited from PullSubscription.)
Public propertySecureInternetPasswordSets the password (as a SecureString object) used when connecting to the Web server using HTTP Basic Authentication.
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. (Inherited from PullSubscription.)
Public propertySubscriberTypeGets or sets whether the subscription is a server or client subscription.
Public propertySubscriptionIdGets the subscription ID value. (Inherited from PullSubscription.)
Public propertySubscriptionTypeGets whether the subscription registration is for a push, pull, or anonymous subscription. (Inherited from PullSubscription.)
Public propertySynchronizationAgentGets an object that represents an instance of the Merge Agent that can be used to synchronize the 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. (Inherited from PullSubscription.)
Public propertySyncTypeGets or sets the manner in which data is initialized at the Subscriber.
Public propertyTypeInfrastructure. Gets or sets the publication type. (Inherited from PullSubscription.)
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). (Inherited from PullSubscription.)
Public propertyUseInteractiveResolverGets or sets whether the Interactive Resolver is used during the synchronization process.
Public propertyUserDataGets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)
Public propertyUseWebSynchronizationGets or sets whether the subscription is synchronized using Web synchronization.
Public propertyWorkingDirectoryGets or sets the path of the directory at the Subscriber that is used to temporarily store and decompress downloaded snapshot files. (Inherited from PullSubscription.)
Top

  NameDescription
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. (Inherited from PullSubscription.)
Public methodDecoupleDecouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public methodEnumSynchronizationPartnersReturns the Alternate Synchronization Partners
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodLastAgentJobHistoryInfoReturns information on the last Synchronization Agent job that was run. (Inherited from PullSubscription.)
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.)
Public methodRefreshReloads the properties of the object. (Inherited from ReplicationObject.)
Public methodReinitializeMarks the merge pull subscription for reinitialization.
Public methodRemoveRemoves the pull subscription. (Inherited from PullSubscription.)
Public methodScriptReturns a Transact-SQL script to create or delete the pull subscription based on the current property setting of the PullSubscription object. (Inherited from PullSubscription.)
Public methodStopSynchronizationJobAttempts to stop a running Merge Agent job that is currently synchronizing the subscription. (Overrides PullSubscription.StopSynchronizationJob().)
Public methodSynchronizeWithJobStarts the agent job asynchronously to synchronize the pull subscription. (Overrides PullSubscription.SynchronizeWithJob().)
Public methodToString (Inherited from Object.)
Top

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.

			// 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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft