Export (0) Print
Expand All

TransPullSubscription.SynchronizeWithJob Method ()


Applies To: SQL Server 2016 Preview

Starts the agent job to synchronize the subscription.

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

public override void SynchronizeWithJob()

Use the TransSynchronizationAgent object returned by the SynchronizationAgent property to start the Distribution Agent synchronously.

If the pull subscription is created with a value of false for CreateSyncAgentByDefault, the default, a Distribution Agent job for the subscription is not created and calling SynchronizeWithJob causes an exception.

Call the StopSynchronizationJob method to stop the job if it is currently running.

The job is not able to start if the Microsoft SQL Server Agent Service is not running. Also if a snapshot is not generated, running the agent job may not synchronize the subscription.

If you have set additional properties on this instance of TransPullSubscription, call CommitPropertyChanges before calling SynchronizeWithJob.

The SynchronizeWithJob method can only be called by members of the sysadmin fixed server role at the Subscriber or by members of the db_owner fixed database role on the subscription database.

Legacy Code Example

			// Define server, publication, and database names.
			String subscriberName = subscriberInstance;
			String publisherName = publisherInstance;
			String publicationName = "AdvWorksProductTran";
			String publicationDbName = "AdventureWorks2012";
            String subscriptionDbName = "AdventureWorks2012Replica";

			// Create a connection to the Subscriber.
			ServerConnection conn = new ServerConnection(subscriberName);

			TransPullSubscription subscription;

				// Connect to the Subscriber.

				// Define subscription properties.
				subscription = new TransPullSubscription();
				subscription.ConnectionContext = conn;
                subscription.DatabaseName = subscriptionDbName;
				subscription.PublisherName = publisherName;
				subscription.PublicationDBName = publicationDbName;
				subscription.PublicationName = publicationName;

				// If the pull subscription and the job exists, start the agent job.
				if (subscription.LoadProperties() && subscription.AgentJobId != null)
					// Do something here if the subscription does not exist.
					throw new ApplicationException(String.Format(
						"A subscription to '{0}' does not exists on {1}",
						publicationName, subscriberName));
			catch (Exception ex)
				// Do appropriate error handling here.
				throw new ApplicationException("The subscription could not be synchronized.", ex);
Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft