MergePullSubscription.SynchronizeWithJob メソッド

定義

エージェントジョブを非同期で開始し、プルサブスクリプションを同期させます。

public:
 override void SynchronizeWithJob();
public override void SynchronizeWithJob();
override this.SynchronizeWithJob : unit -> unit
Public Overrides Sub SynchronizeWithJob ()

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

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

MergePullSubscription subscription;

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

    // Define subscription properties.
    subscription = new MergePullSubscription();
    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)
    {
        subscription.SynchronizeWithJob();
    }
    else
    {
        // 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);
}
finally
{
    conn.Disconnect();
}
' Define server, publication, and database names.
Dim subscriberName As String = subscriberInstance
Dim publisherName As String = publisherInstance
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim publicationDbName As String = "AdventureWorks2012"
Dim subscriptionDbName As String = "AdventureWorks2012Replica"

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

Dim subscription As MergePullSubscription

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

    ' Define subscription properties.
    subscription = New MergePullSubscription()
    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() And Not subscription.AgentJobId Is Nothing Then
        subscription.SynchronizeWithJob()
    Else
        ' 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))
    End If
Catch ex As Exception
    ' Do appropriate error handling here.
    Throw New ApplicationException("The subscription could not be synchronized.", ex)
Finally
    conn.Disconnect()
End Try

注釈

SynchronizationAgentプロパティで返されるMergeSynchronizationAgentオブジェクトを使って、マージ エージェントを同期的に開始します。

プルサブスクリプションがCreateSyncAgentByDefaultのfalse値で作成された場合、デフォルトではサブスクリプションのマージ エージェントジョブが作成されず、SynchronizeWithJobを呼び出すと例外が発生します。

もしジョブが現在実行中であれば、 StopSynchronizationJob メソッドを呼び出してジョブを停止してください。

Microsoft SQL Server エージェント Serviceが実行されていないとジョブが開始できません。 また、スナップショットが生成されない場合、エージェントジョブを実行してもサブスクリプションの同期が起こらないことがあります。

このMergePullSubscriptionインスタンスに追加のプロパティを設定している場合は、SynchronizeWithJobを呼ぶ前にCommitPropertyChangesを呼び出してください。

SynchronizeWithJobメソッドは、加入者のシステム管理者固定サーバー役割のメンバーか、サブスクリプションデータベースのdb_owner固定データベース役割のメンバーのみが呼び出せます。

適用対象

こちらもご覧ください