Export (0) Print
Expand All

TransSubscription.SynchronizeWithJob Method

Starts the agent job to synchronize the subscription.

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

public void SynchronizeWithJob ()
public void SynchronizeWithJob ()
public function SynchronizeWithJob ()

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. Calling SynchronizeWithJob will cause an exception to occur.

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

The job is not able to start if the 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 properties on this instance of TransSubscription, 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.

The SynchronizeWithJob method is available with SQL Server 2005 only.

This namespace, class, or member is supported only in version 2.0 of the .NET Framework.

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

/// Create a connection to the Publisher.
ServerConnection conn = new ServerConnection(publisherName);

TransSubscription subscription;

    // Connect to the Publisher.

    // Instantiate the push subscription.
    subscription = new TransSubscription();
    subscription.ConnectionContext = conn;
    subscription.DatabaseName = publicationDbName;
    subscription.PublicationName = publicationName;
    subscription.SubscriptionDBName = subscriptionDbName;
    subscription.SubscriberName = subscriberName;

    // If the push subscription and the job exists, start the agent job.
    if (subscription.LoadProperties() && subscription.AgentJobId != null)
        // Start the Distribution Agent asynchronously.
        // 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)
    // Implement appropriate error handling here.
    throw new ApplicationException("The subscription could not be synchronized.", ex);

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

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

© 2015 Microsoft