Export (0) Print
Expand All

MergeSubscription Class

Represents a subscription to a merge publication registered at the Publisher.

Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.Subscription
      Microsoft.SqlServer.Replication.MergeSubscription

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

public sealed class MergeSubscription : Subscription

The MergeSubscription type exposes the following members.

  NameDescription
Public methodMergeSubscription()Creates a new instance of the MergeSubscription class.
Public methodMergeSubscription(String, String, String, String, ServerConnection)Creates a new instance of the MergeSubscription class with the specified connection to the Publisher and the properties that uniquely define the subscription.
Top

  NameDescription
Public propertyAgentJobIdGets the ID of the agent job used to synchronize the subscription. (Inherited from Subscription.)
Public propertyAgentOffloadGets or sets whether 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 Subscription.)
Public propertyAgentOffloadServerGets or sets the name of the remote computer where the agent runs when using remote agent activation. (Inherited from Subscription.)
Public propertyAgentScheduleGets the schedule for the agent job used to synchronize the subscription. (Inherited from Subscription.)
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 the agent job used to synchronize the subscription is created by default. (Inherited from Subscription.)
Public propertyDatabaseNameGets or sets the name of the publication database. (Inherited from Subscription.)
Public propertyDescriptionGets or sets a textual description of the merge subscription.
Public propertyEnabledForSynchronizationManagerSpecifies whether the subscription can be synchronized using Microsoft Windows Synchronization Manager. (Inherited from Subscription.)
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 propertyIsExistingObjectGets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public propertyNameGets the name assigned to an existing subscription. (Inherited from Subscription.)
Public propertyPriorityGets or sets the relative priority value assigned to a server subscription.
Public propertyPublicationNameGets or sets the name of the publication to which the subscription subscribes. (Inherited from Subscription.)
Public propertyPublisherSecurityGets the security context used by the Merge Agent to connect to the Publisher.
Public propertySqlServerNameGets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public propertyStatusGets the status of the subscription. (Inherited from Subscription.)
Public propertySubscriberNameGets or sets the name of the instance of Microsoft SQL Server that is the Subscriber. (Inherited from Subscription.)
Public propertySubscriberSecurityGets the security context used to connect to the Subscriber. (Inherited from Subscription.)
Public propertySubscriberTypeGets or sets whether the subscription is a client or server subscription.
Public propertySubscriptionDBNameGets or sets the name of the database on the Subscriber that receives the replicated data. (Inherited from Subscription.)
Public propertySubscriptionTypeGets whether the subscription registration is for a push or pull subscription. (Inherited from Subscription.)
Public propertySynchronizationAgentGets an instance of the MergeSynchronizationAgent class that can be used to synchronize the subscription.
Public propertySynchronizationAgentNameGets or sets the name of the agent job created to synchronize the subscription. (Inherited from 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 Subscription.)
Public propertySyncTypeGets or sets the manner in which the subscription is initialized. (Inherited from Subscription.)
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.)
Top

  NameDescription
Public methodCommitPropertyChangesSends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public methodCreateCreates the subscription registration at the Publisher. (Inherited from Subscription.)
Public methodDecoupleDecouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
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 subscription for reinitialization.
Public methodRemoveDeletes the subscription registration at the Publisher and removes replication objects at the Subscriber for a push subscription. (Inherited from Subscription.)
Public methodScriptReturns a Transact-SQL script that can be used to create or delete the subscription. (Inherited from Subscription.)
Public methodStopSynchronizationJobAttempts to stop a running Merge Agent job that is currently synchronizing the subscription.
Public methodSynchronizeWithJobStarts the agent job to synchronize the subscription.
Public methodToString (Inherited from Object.)
Top

The MergeSubscription class is used with both pull and push subscriptions to a merge publication.

When configuring a Publisher with a remote Distributor, the values supplied for all parameters, including SynchronizationAgentProcessSecurity, are sent to the Distributor as plain text. You should encrypt the connection between the Publisher and its remote Distributor before calling the Create method. For more information, see sp_reinitmergesubscription (Transact-SQL).

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 a connection to the Publisher.
			ServerConnection conn = new ServerConnection(subscriberName);

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

			try
			{
				// Connect to the Publisher.
				conn.Connect();

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

				if (publication.IsExistingObject)
				{
					if ((publication.Attributes & PublicationAttributes.AllowPush) == 0)
					{
						publication.Attributes |= PublicationAttributes.AllowPush;
					}

					// Define the push subscription.
					subscription = new MergeSubscription();
					subscription.ConnectionContext = conn;
					subscription.SubscriberName = subscriberName;
					subscription.PublicationName = publicationName;
					subscription.DatabaseName = publicationDbName;
					subscription.SubscriptionDBName = subscriptionDbName;
					subscription.HostName = hostname;

					// Set a schedule to synchronize the subscription every 2 hours
					// during weekdays from 6am to 10pm.
					subscription.AgentSchedule.FrequencyType = ScheduleFrequencyType.Weekly;
					subscription.AgentSchedule.FrequencyInterval = Convert.ToInt32(0x003E);
					subscription.AgentSchedule.FrequencyRecurrenceFactor = 1;
					subscription.AgentSchedule.FrequencySubDay = ScheduleFrequencySubDay.Hour;
					subscription.AgentSchedule.FrequencySubDayInterval = 2;
					subscription.AgentSchedule.ActiveStartDate = 20051108;
					subscription.AgentSchedule.ActiveEndDate = 20071231;
					subscription.AgentSchedule.ActiveStartTime = 060000;
					subscription.AgentSchedule.ActiveEndTime = 100000;

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

					// Create the push subscription.
					subscription.Create();
				}
				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
			{
				conn.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 a connection to the Publisher.
Dim conn As ServerConnection = New ServerConnection(subscriberName)

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

Try
    ' Connect to the Publisher.
    conn.Connect()

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

    If publication.IsExistingObject Then
        If (publication.Attributes And PublicationAttributes.AllowPush) = 0 Then
            publication.Attributes = publication.Attributes _
            Or PublicationAttributes.AllowPush
        End If

        ' Define the push subscription.
        subscription = New MergeSubscription()
        subscription.ConnectionContext = conn
        subscription.SubscriberName = subscriberName
        subscription.PublicationName = publicationName
        subscription.DatabaseName = publicationDbName
        subscription.SubscriptionDBName = subscriptionDbName
        subscription.HostName = hostname

        ' Set a schedule to synchronize the subscription every 2 hours
        ' during weekdays from 6am to 10pm.
        subscription.AgentSchedule.FrequencyType = ScheduleFrequencyType.Weekly
        subscription.AgentSchedule.FrequencyInterval = Convert.ToInt32("0x003E", 16)
        subscription.AgentSchedule.FrequencyRecurrenceFactor = 1
        subscription.AgentSchedule.FrequencySubDay = ScheduleFrequencySubDay.Hour
        subscription.AgentSchedule.FrequencySubDayInterval = 2
        subscription.AgentSchedule.ActiveStartDate = 20051108
        subscription.AgentSchedule.ActiveEndDate = 20071231
        subscription.AgentSchedule.ActiveStartTime = 60000
        subscription.AgentSchedule.ActiveEndTime = 100000

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

        ' Create the push subscription.
        subscription.Create()
    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
    conn.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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft