同期スケジュールの指定
適用対象: SQL Server Azure SQL Managed Instance
このトピックでは、SQL Server Management Studio、Transact-SQL、またはレプリケーション管理オブジェクト (RMO) を使用して SQL Server の同期スケジュールを指定する方法について説明します。 サブスクリプションを作成するときに、サブスクリプションのレプリケーション エージェントをいつ実行するかを制御する同期スケジュールを定義できます。 スケジュール設定のパラメーターを指定しなかった場合、サブスクリプションは既定のスケジュールを使用します。
サブスクリプションは、ディストリビューション エージェント (スナップショット レプリケーションおよびトランザクション レプリケーションの場合) またはマージ エージェント (マージ レプリケーションの場合) で同期されます。 エージェントは継続的に実行、要求時に実行、またはスケジュールで実行できます。
このトピックの内容
同期スケジュールを指定するために使用するもの:
SQL Server Management Studio を使用する
サブスクリプションの新規作成ウィザードの [同期スケジュール] ページで同期スケジュールを指定します。 このウィザードへのアクセスの詳細については、「 Create a Push Subscription 」および「 Create a Pull Subscription」を参照してください。
[ジョブ スケジュールのプロパティ] ダイアログ ボックスで同期スケジュールを変更します。このダイアログ ボックスは、SQL Server Management Studio の [ジョブ] フォルダーおよびレプリケーション モニターのエージェントの詳細ウィンドウから使用できます。 レプリケーション モニターの起動の詳細については、「Start the Replication Monitor」 (レプリケーション モニターの開始) を参照してください。
[ジョブ] フォルダーからスケジュールを指定する場合は、次の表でエージェントのジョブ名を確認してください。
エージェント | ジョブ名 |
---|---|
プル サブスクリプションに対するマージ エージェント | <Publisher>-<PublicationDatabase>-<Publication>-<Subscriber>-<SubscriptionDatabase>-<integer> |
プッシュ サブスクリプションに対するマージ エージェント | <Publisher>-<PublicationDatabase>-<Publication>-<Subscriber>-<integer> |
プッシュ サブスクリプションに対するディストリビューション エージェント | <Publisher>-<PublicationDatabase>-<Publication>-<Subscriber>-<integer> 1 |
プル サブスクリプションに対するディストリビューション エージェント | <Publisher>-<PublicationDatabase>-<Publication>-<Subscriber>-<SubscriptionDatabase>-<GUID> 2 |
SQL Server 以外のサブスクライバーへのプッシュ サブスクリプションに対するディストリビューション エージェント | <Publisher>-<PublicationDatabase>-<Publication>-<Subscriber>-<integer> |
1 Oracle パブリケーションに対するプッシュ サブスクリプションの場合は、<Publisher>-<PublicationDatabase> ではなく <Publisher>-<Publisher> になります
2 Oracle パブリケーションに対するプル サブスクリプションの場合は、<Publisher>-<PublicationDatabase> ではなく <Publisher>-<DistributionDatabase> になります
同期スケジュールを指定するには
サブスクリプションの新規作成ウィザードの [同期スケジュール] ページで、作成する各サブスクリプションについて、[エージェント スケジュール] ボックスの一覧から以下のいずれかの値を選択します。
[連続実行する]
[要求時にのみ実行する]
[<スケジュールの定義...>]
[<スケジュールの定義...>] を選択した場合は、[ジョブ スケジュールのプロパティ] ダイアログ ボックスでスケジュールを指定し、[OK] をクリックします。
ウィザードの完了。
レプリケーション モニターでプッシュ サブスクリプションの同期スケジュールを変更するには
レプリケーション モニターの左ペインのパブリッシャー グループを展開し、パブリッシャーを展開して、パブリケーションをクリックします。
[すべてのサブスクリプション] タブをクリックします。
サブスクリプションを右クリックし、 [詳細表示]をクリックします。
[サブスクリプション < SubscriptionName>] ウィンドウで、[アクション] をクリックし、[<AgentName> ジョブのプロパティ] をクリックします。
[ジョブのプロパティ - <JobName>] ダイアログ ボックスの [スケジュール] ページで、[編集] をクリックします。
[ジョブ スケジュールのプロパティ] ダイアログ ボックスで、 [スケジュールの種類] ボックスの一覧の値を選択します。
エージェントを連続実行するには、 [SQL Server エージェントの開始時に自動的に開始]を選択します。
エージェントをスケジュールで実行するには、 [定期的]を選択します。
エージェントを要求時に実行するには、 [指定日時]を選択します。
[定期的]を選択した場合は、エージェントのスケジュールを指定します。
[OK] を選択します。
Management Studio でプッシュ サブスクリプションの同期スケジュールを変更するには
Management Studio でディストリビューターに接続し、サーバー ノードを展開します。
[SQL Server エージェント] フォルダーを展開して、 [ジョブ] フォルダーを展開します。
サブスクリプションに関連付けられているディストリビューション エージェントまたはマージ エージェントのジョブを右クリックし、 [プロパティ]をクリックします。
[ジョブのプロパティ - <JobName>] ダイアログ ボックスの [スケジュール] ページで、[編集] をクリックします。
[ジョブ スケジュールのプロパティ] ダイアログ ボックスで、 [スケジュールの種類] ボックスの一覧の値を選択します。
エージェントを連続実行するには、 [SQL Server エージェントの開始時に自動的に開始]を選択します。
エージェントをスケジュールで実行するには、 [定期的]を選択します。
エージェントを要求時に実行するには、 [指定日時]を選択します。
[定期的]を選択した場合は、エージェントのスケジュールを指定します。
[OK] を選択します。
Management Studio でプル サブスクリプションの同期スケジュールを変更するには
Management Studio でサブスクライバ―に接続し、サーバー ノードを展開します。
[SQL Server エージェント] フォルダーを展開して、 [ジョブ] フォルダーを展開します。
サブスクリプションに関連付けられているディストリビューション エージェントまたはマージ エージェントのジョブを右クリックし、 [プロパティ]をクリックします。
[ジョブのプロパティ - <JobName>] ダイアログ ボックスの [スケジュール] ページで、[編集] をクリックします。
[ジョブ スケジュールのプロパティ] ダイアログ ボックスで、 [スケジュールの種類] ボックスの一覧の値を選択します。
エージェントを連続実行するには、 [SQL Server エージェントの開始時に自動的に開始]を選択します。
エージェントをスケジュールで実行するには、 [定期的]を選択します。
エージェントを要求時に実行するには、 [指定日時]を選択します。
[定期的]を選択した場合は、エージェントのスケジュールを指定します。
[OK] を選択します。
Transact-SQL の使用
レプリケーション ストアド プロシージャを使用してプログラムで同期スケジュールを定義できます。 使用するストアド プロシージャは、レプリケーションの種類およびサブスクリプションの種類 (プルまたはプッシュ) によって異なります。
スケジュールを定義するには、次のスケジュール設定のパラメーターを使用します。これらのパラメーターの動作は、sp_add_schedule (Transact-SQL) から継承されます。
@frequency_type - エージェントのスケジュール設定に使用する頻度の種類。
@frequency_interval - エージェントを実行する曜日。
@frequency_relative_interval - エージェントを月単位でスケジュール設定する場合の指定された月の週。
@frequency_recurrence_factor - 同期から同期の間に発生する頻度の単位の数。
@frequency_subday - エージェントを 1 日に複数回実行する場合の頻度の単位。
@frequency_subday_interval - エージェントを 1 日に複数回実行する場合の実行から実行の間の頻度の単位の数。
@active_start_time_of_day - 指定された日のエージェントの実行を開始する最も早い時刻。
@active_end_time_of_day - 指定された日のエージェントの実行を開始する最も遅い時刻。
@active_start_date - エージェント スケジュールが有効になる最初の日。
@active_end_date - エージェント スケジュールが有効である最後の日。
トランザクション パブリケーションに対するプル サブスクリプションの同期スケジュールを定義するには
トランザクション パブリケーションに対して新しいプル サブスクリプションを作成します。 詳細については、「 プル サブスクリプションの作成」をご覧ください。
サブスクライバーで、sp_addpullsubscription_agent (Transact-SQL) を実行します。 @publisher、@publisher_db、および @publication を指定し、@job_name および @password にはサブスクライバーでディストリビューション エージェントを実行するときに使用する Microsoft Windows 資格情報を指定します。 サブスクリプションを同期するディストリビューション エージェント ジョブのスケジュールを定義する、上述の同期のパラメーターを指定します。
トランザクション パブリケーションに対するプッシュ サブスクリプションの同期スケジュールを定義するには
トランザクション パブリケーションに対して新しいプッシュ サブスクリプションを作成します。 詳細については、「 プッシュ サブスクリプションの作成」をご覧ください。
サブスクライバーで、sp_addpushsubscription_agent (Transact-SQL) を実行します。 @subscriber、 @subscriber_db、および @publicationを指定し、 @job_name および @passwordにはサブスクライバーでディストリビューション エージェントを実行するときに使用する Windows 資格情報を指定します。 サブスクリプションを同期するディストリビューション エージェント ジョブのスケジュールを定義する、上述の同期のパラメーターを指定します。
マージ パブリケーションに対するプル サブスクリプションの同期スケジュールを定義するには
マージ パブリケーションに対して新しいプル サブスクリプションを作成します。 詳細については、「 プル サブスクリプションの作成」をご覧ください。
サブスクライバーで、 sp_addmergepullsubscription_agentを実行します。 @publisher、 @publisher_db、および @publicationを指定し、 @job_name および @passwordにはサブスクライバーでマージ エージェントを実行するときに使用する Windows 資格情報を指定します。 サブスクリプションを同期するマージ エージェント ジョブのスケジュールを定義する、上述の同期のパラメーターを指定します。
マージ パブリケーションに対するプッシュ サブスクリプションの同期スケジュールを定義するには
マージ パブリケーションに対して新しいプッシュ サブスクリプションを作成します。 詳細については、「 プッシュ サブスクリプションの作成」をご覧ください。
サブスクライバーで、 sp_addmergepushsubscription_agentを実行します。 @subscriber、 @subscriber_db、および @publicationを指定し、 @job_name および @passwordにはサブスクライバーでマージ エージェントを実行するときに使用する Windows 資格情報を指定します。 サブスクリプションを同期するマージ エージェント ジョブのスケジュールを定義する、上述の同期のパラメーターを指定します。
レプリケーション管理オブジェクト (RMO) の使用
レプリケーションは、SQL Server エージェントを使用して、スナップショットの生成やサブスクリプションの同期など、定期的に発生する動作のジョブをスケジュール設定します。 レプリケーション管理オブジェクト (RMO) をプログラムで使用して、レプリケーション エージェント ジョブのスケジュールを指定できます。
Note
サブスクリプションを作成し、 false に CreateSyncAgentByDefault を指定すると (プル サブスクリプションの既定の動作)、エージェント ジョブは作成されず、スケジュール設定のプロパティは無視されます。 この場合は、アプリケーションによって同期スケジュールを決定する必要があります。 詳細については、「 Create a Pull Subscription 」および「 Create a Push Subscription」を参照してください。
トランザクション パブリケーションに対するプッシュ サブスクリプションを作成するレプリケーション エージェント スケジュールを定義するには
作成するサブスクリプションに対して TransSubscription クラスのインスタンスを作成します。 詳細については、「 プッシュ サブスクリプションの作成」をご覧ください。
Createを呼び出す前に、 AgentSchedule プロパティの次のフィールドを 1 つ以上設定します。
FrequencyType - エージェントのスケジュール設定時に使用する頻度の種類 (毎日、毎週など)。
FrequencyInterval - エージェントを実行する曜日。
FrequencyRelativeInterval - エージェントを月単位でスケジュール設定する場合の指定された月の週。
FrequencyRecurrenceFactor - 同期から同期の間に発生する頻度の種類の単位の数。
FrequencySubDay - エージェントを 1 日に複数回実行する場合の頻度の単位。
FrequencySubDayInterval - エージェントを 1 日に複数回実行する場合の頻度の単位。
ActiveStartTime - エージェントの実行を開始する特定の日の最も早い時刻。
ActiveEndTime - エージェントの実行を開始する特定の日の最も遅い時刻。
ActiveStartDate - エージェント スケジュールが有効になっている最初の日。
ActiveEndDate - エージェント スケジュールが有効になっている最後の日。
Note
これらのプロパティを指定しなかった場合、既定値が設定されます。
Create メソッドを呼び出してサブスクリプションを作成します。
トランザクション パブリケーションに対するプル サブスクリプションを作成するレプリケーション エージェント スケジュールを定義するには
作成するサブスクリプションに対して TransPullSubscription クラスのインスタンスを作成します。 詳細については、「 プル サブスクリプションの作成」をご覧ください。
Createを呼び出す前に、 AgentSchedule プロパティの次のフィールドを 1 つ以上設定します。
FrequencyType - エージェントのスケジュール設定時に使用する頻度の種類 (毎日、毎週など)。
FrequencyInterval - エージェントを実行する曜日。
FrequencyRelativeInterval - エージェントを月単位でスケジュール設定する場合の指定された月の週。
FrequencyRecurrenceFactor - 同期から同期の間に発生する頻度の種類の単位の数。
FrequencySubDay - エージェントを 1 日に複数回実行する場合の頻度の単位。
FrequencySubDayInterval - エージェントを 1 日に複数回実行する場合の頻度の単位。
ActiveStartTime - エージェントの実行を開始する特定の日の最も早い時刻。
ActiveEndTime - エージェントの実行を開始する特定の日の最も遅い時刻。
ActiveStartDate - エージェント スケジュールが有効になっている最初の日。
ActiveEndDate - エージェント スケジュールが有効になっている最後の日。
Note
これらのプロパティを指定しなかった場合、既定値が設定されます。
Create メソッドを呼び出してサブスクリプションを作成します。
マージ パブリケーションに対するプル サブスクリプションを作成するレプリケーション エージェント スケジュールを定義するには
作成するサブスクリプションに対して MergePullSubscription クラスのインスタンスを作成します。 詳細については、「 プル サブスクリプションの作成」をご覧ください。
Createを呼び出す前に、 AgentSchedule プロパティの次のフィールドを 1 つ以上設定します。
FrequencyType - エージェントのスケジュール設定時に使用する頻度の種類 (毎日、毎週など)。
FrequencyInterval - エージェントを実行する曜日。
FrequencyRelativeInterval - エージェントを月単位でスケジュール設定する場合の指定された月の週。
FrequencyRecurrenceFactor - 同期から同期の間に発生する頻度の種類の単位の数。
FrequencySubDay - エージェントを 1 日に複数回実行する場合の頻度の単位。
FrequencySubDayInterval - エージェントを 1 日に複数回実行する場合の頻度の単位。
ActiveStartTime - エージェントの実行を開始する特定の日の最も早い時刻。
ActiveEndTime - エージェントの実行を開始する特定の日の最も遅い時刻。
ActiveStartDate - エージェント スケジュールが有効になっている最初の日。
ActiveEndDate - エージェント スケジュールが有効になっている最後の日。
Note
これらのプロパティを指定しなかった場合、既定値が設定されます。
Create メソッドを呼び出してサブスクリプションを作成します。
マージ パブリケーションに対するプッシュ サブスクリプションを作成するレプリケーション エージェント スケジュールを定義するには
作成するサブスクリプションに対して MergeSubscription クラスのインスタンスを作成します。 詳細については、「 プッシュ サブスクリプションの作成」をご覧ください。
Createを呼び出す前に、 AgentSchedule プロパティの次のフィールドを 1 つ以上設定します。
FrequencyType - エージェントのスケジュール設定時に使用する頻度の種類 (毎日、毎週など)。
FrequencyInterval - エージェントを実行する曜日。
FrequencyRelativeInterval - エージェントを月単位でスケジュール設定する場合の指定された月の週。
FrequencyRecurrenceFactor - 同期から同期の間に発生する頻度の種類の単位の数。
FrequencySubDay - エージェントを 1 日に複数回実行する場合の頻度の単位。
FrequencySubDayInterval - エージェントを 1 日に複数回実行する場合の頻度の単位。
ActiveStartTime - エージェントの実行を開始する特定の日の最も早い時刻。
ActiveEndTime - エージェントの実行を開始する特定の日の最も遅い時刻。
ActiveStartDate - エージェント スケジュールが有効になっている最初の日。
ActiveEndDate - エージェント スケジュールが有効になっている最後の日。
Note
これらのプロパティを指定しなかった場合、既定値が設定されます。
Create メソッドを呼び出してサブスクリプションを作成します。
例 (RMO)
次の例では、マージ パブリケーションに対するプッシュ サブスクリプションを作成して、サブスクリプションを同期するスケジュールを指定します。
// Define the Publisher, publication, and databases.
string publicationName = "AdvWorksSalesOrdersMerge";
string publisherName = publisherInstance;
string subscriberName = subscriberInstance;
string subscriptionDbName = "AdventureWorks2022Replica";
string publicationDbName = "AdventureWorks2022";
string hostname = @"adventure-works\garrett1";
//Create a connection to the Publisher.
ServerConnection conn = new ServerConnection(publisherName);
// 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 = "AdventureWorks2022Replica"
Dim publicationDbName As String = "AdventureWorks2022"
Dim hostname As String = "adventure-works\garrett1"
'Create a connection to the Publisher.
Dim conn As ServerConnection = New ServerConnection(publisherName)
' 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