sp_addsubscriber_schedule (Transact-SQL)
ディストリビューション エージェントとマージ エージェントのスケジュールを追加します。このストアド プロシージャは、任意のデータベース上のパブリッシャ側で実行されます。
構文
sp_addsubscriber_schedule [ @subscriber = ] 'subscriber'
[ , [ @agent_type = ] agent_type ]
[ , [ @frequency_type = ] frequency_type ]
[ , [ @frequency_interval = ] frequency_interval ]
[ , [ @frequency_relative_interval = ] frequency_relative_interval ]
[ , [ @frequency_recurrence_factor = ] frequency_recurrence_factor ]
[ , [ @frequency_subday = ] frequency_subday ]
[ , [ @frequency_subday_interval = ] frequency_subday_interval ]
[ , [ @active_start_time_of_day = ] active_start_time_of_day ]
[ , [ @active_end_time_of_day = ] active_end_time_of_day ]
[ , [ @active_start_date = ] active_start_date ]
[ , [ @active_end_date = ] active_end_date ]
[ , [ @publisher = ] 'publisher' ]
引数
[ @subscriber = ] 'subscriber'
サブスクライバの名前を指定します。subscriber のデータ型は sysname です。サブスクライバの名前は、データベース内で一意であること、既存の名前でないこと、NULL でないことが必要です。[ @agent_type = ] agent_type
エージェントの種類を指定します。agent_type のデータ型は smallint で、次のいずれかの値を指定できます。値
説明
0 (既定値)
ディストリビューション エージェント
1
マージ エージェント
[ @frequency_type = ] frequency_type
ディストリビューション エージェントをスケジュールに組み込む頻度を指定します。frequency_type のデータ型は int で、次のいずれかの値を指定できます。値
説明
1
1 回
2
要求時
4
毎日
8
毎週
16
毎月
32
月単位
64 (既定値)
自動的に起動
128
定期的
[ @frequency_interval = ] frequency_interval
frequency_type で設定した頻度に適用される値を指定します。frequency_interval のデータ型は int で、既定値は 1 です。[ @frequency_relative_interval = ] frequency_relative_interval
ディストリビューション エージェントを実行する日付を指定します。frequency_type を 32 (月単位) に設定したときにこのパラメータを使用します。frequency_relative_interval のデータ型は int で、次のいずれかの値を指定できます。値
説明
1 (既定値)
第 1
2
第 2
4
第 3
8
第 4
16
最終
[ @frequency_recurrence_factor = ] frequency_recurrence_factor
frequency_type で使用される定期実行係数を指定します。frequency_recurrence_factor のデータ型は int で、既定値は 0 です。[ @frequency_subday = ] frequency_subday
定義した期間にスケジュールを組み直す頻度を指定します。frequency_subday のデータ型は int で、次のいずれかの値を指定できます。値
説明
1
1 回
2
2 回
4 (既定値)
分
8
時
[ @frequency_subday_interval = ] frequency_subday_interval
frequency_subday の間隔を指定します。frequency_subday_interval のデータ型は int で、既定値は 5 です。[ @active_start_time_of_day = ] active_start_time_of_day
ディストリビューション エージェントを最初にスケジュール設定する時刻を HHMMSS 形式で指定します。active_start_time_of_day のデータ型は int で、既定値は 0 です。[ @active_end_time_of_day = ] active_end_time_of_day
ディストリビューション エージェントのスケジュール設定を停止する時刻を HHMMSS 形式で指定します。active_end_time_of_day のデータ型は int で、既定値は 235959 です。235959 は、24 時間制の午後 11 時 59 分 59 秒を意味します。[ @active_start_date = ] active_start_date
ディストリビューション エージェントを最初にスケジュール設定する日付を YYYYMMDD 形式で指定します。active_start_date のデータ型は int で、既定値は 0 です。[ @active_end_date = ] active_end_date
ディストリビューション エージェントのスケジュール設定を停止する日付を YYYYMMDD 形式で指定します。active_end_date のデータ型は int で、既定値は 99991231 です。これは 9999 年 12 月 31 日を示します。[ @publisher = ] 'publisher'
MicrosoftSQL Server 以外のパブリッシャを指定します。publisher のデータ型は sysname で、既定値は NULL です。注意 SQL Server パブリッシャには publisher を指定しないでください。
戻り値
0 (成功) または 1 (失敗)
説明
sp_addsubscriber_schedule は、スナップショット レプリケーション、トランザクション レプリケーション、およびマージ レプリケーションで使用します。
権限
sp_addsubscriber_schedule を実行できるのは、sysadmin 固定サーバー ロールのメンバだけです。