Export (0) Print
Expand All

TransPullSubscription.SynchronizationAgent Property

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

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

function get SynchronizationAgent () : TransSynchronizationAgent

Call the Synchronize method on the returned TransSynchronizationAgent object to synchronize the subscription.

Call CommitPropertyChanges to save any property changes on the server before retrieving SynchronizationAgent to synchronize the subscription.

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. You may need to specify additional properties on the returned TransSynchronizationAgent object before it can be used to synchronize the subscription.

The SynchronizationAgent property can only be retrieved 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.

Retrieving the SynchronizationAgent property is equivalent to executing sp_helppullsubscription.

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

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

            TransPullSubscription subscription;

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

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

	            // If the pull subscription exists, then start the synchronization.
	            if (subscription.LoadProperties())
	            {
		            // Check that we have enough metadata to start the agent.
		            if (subscription.PublisherSecurity != null)
		            {
                        // Synchronously start the Distribution Agent for the subscription.
			            subscription.SynchronizationAgent.Synchronize();
		            }
		            else
		            {
			            throw new ApplicationException("There is insufficent metadata to " +
				            "synchronize the subscription. Recreate the subscription with " +
				            "the agent job or supply the required agent properties at run time.");
		            }
	            }
	            else
	            {
		            // Do something here if the pull subscription does not exist.
		            throw new ApplicationException(String.Format(
			            "A subscription to '{0}' does not exist on {1}",
			            publicationName, subscriberName));
	            }
            }
            catch (Exception ex)
            {
	            // Implement appropriate error handling here.
	            throw new ApplicationException("The subscription could not be " +
		            "synchronized. Verify that the subscription has " +
		            "been defined correctly.", ex);
            }
            finally
            {
	            conn.Disconnect();
            }
' Define the server, publication, and database names.
Dim subscriberName As String = subscriberInstance
Dim publisherName As String = publisherInstance
Dim publicationName As String = "AdvWorksProductTran"
Dim subscriptionDbName As String = "AdventureWorks2012Replica"
Dim publicationDbName As String = "AdventureWorks2012"

' Create a connection to the Subscriber.
Dim conn As ServerConnection = New ServerConnection(subscriberName)

Dim subscription As TransPullSubscription

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

    ' Define the pull subscription.
    subscription = New TransPullSubscription()
    subscription.ConnectionContext = conn
    subscription.DatabaseName = subscriptionDbName
    subscription.PublisherName = publisherName
    subscription.PublicationDBName = publicationDbName
    subscription.PublicationName = publicationName

    ' If the pull subscription exists, then start the synchronization.
    If subscription.LoadProperties() Then
        ' Check that we have enough metadata to start the agent.
        If Not subscription.PublisherSecurity Is Nothing Then

            ' Write agent output to a log file.
            subscription.SynchronizationAgent.Output = "distagent.log"
            subscription.SynchronizationAgent.OutputVerboseLevel = 2

            ' Synchronously start the Distribution Agent for the subscription.
            subscription.SynchronizationAgent.Synchronize()
        Else
            Throw New ApplicationException("There is insufficent metadata to " + _
             "synchronize the subscription. Recreate the subscription with " + _
             "the agent job or supply the required agent properties at run time.")
        End If
    Else
        ' Do something here if the pull subscription does not exist.
        Throw New ApplicationException(String.Format( _
         "A subscription to '{0}' does not exist on {1}", _
         publicationName, subscriberName))
    End If
Catch ex As Exception
    ' Implement appropriate error handling here.
    Throw New ApplicationException("The subscription could not be " + _
     "synchronized. Verify that the subscription has " + _
     "been defined correctly.", ex)
Finally
    conn.Disconnect()
End Try

Community Additions

ADD
Show:
© 2014 Microsoft