sp_add_jobschedule (Transact-SQL)
適用対象: 
SQL Server Azure SQL Managed Instance
SQL Server エージェント ジョブのスケジュールを作成します。
重要
現在、Azure SQL Managed Instance によって、すべてではありませんが、ほとんどの SQL Server エージェントの機能がサポートされています。 詳細については、Azure SQL Managed Instance と SQL Server の T-SQL の相違点に関するページを参照してください。
構文
sp_add_jobschedule
[ [ @job_id = ] 'job_id' ]
[ , [ @job_name = ] N'job_name' ]
, [ @name = ] N'name'
[ , [ @enabled = ] enabled ]
[ , [ @freq_type = ] freq_type ]
[ , [ @freq_interval = ] freq_interval ]
[ , [ @freq_subday_type = ] freq_subday_type ]
[ , [ @freq_subday_interval = ] freq_subday_interval ]
[ , [ @freq_relative_interval = ] freq_relative_interval ]
[ , [ @freq_recurrence_factor = ] freq_recurrence_factor ]
[ , [ @active_start_date = ] active_start_date ]
[ , [ @active_end_date = ] active_end_date ]
[ , [ @active_start_time = ] active_start_time ]
[ , [ @active_end_time = ] active_end_time ]
[ , [ @schedule_id = ] schedule_id OUTPUT ]
[ , [ @automatic_post = ] automatic_post ]
[ , [ @schedule_uid = ] 'schedule_uid' OUTPUT ]
[ ; ]
引数
[ @job_id = ] 'job_id'
スケジュールを追加するジョブの識別番号を指定します。 @job_id は uniqueidentifier で、既定値は NULL です。
@job_idまたは@job_nameを指定する必要がありますが、両方を指定することはできません。
[ @job_name = ] N'job_name'
スケジュールが追加されるジョブの名前。 @job_name は sysname で、既定値は NULL です。
@job_idまたは@job_nameを指定する必要がありますが、両方を指定することはできません。
[ @name = ] N'name'
スケジュールの名前。 @name は sysname で、既定値はありません。
[ @enabled = ] enabled
スケジュールの現在の状態を示します。 @enabled は tinyint で、既定値は 1 (有効) です。 0場合、スケジュールは有効になりません。 スケジュールが無効になっている場合、ジョブは実行されません。
[ @freq_type = ] freq_type
いつジョブを実行するかを示す値を指定します。 @freq_type は int で、次のいずれかの値を指定できます。
| 値 | 説明 |
|---|---|
1 |
1 回。 |
4 |
毎日 |
8 |
週単位 |
16 |
月単位 |
32 |
月単位( @freq_intervalに対する相対値)。 |
64 |
SQL Server エージェント サービスの起動時に実行します。 |
128 |
コンピューターがアイドル状態のときに実行します。 |
[ @freq_interval = ] freq_interval
ジョブを実行する日を指定します。 @freq_interval は int (既定値は 0) であり、次の表に示すように @freq_type の値によって異なります。
| @freq_typeの値 | @freq_intervalへの影響 |
|---|---|
1 (1 回) |
@freq_interval は使用されません。 |
4 (毎日) |
@freq_interval日ごと。 |
8 (毎週) |
@freq_interval は、次の 1 つ以上です ( OR 論理演算子と組み合わせます)。1 = 日曜日2 = 月曜日4 = 火曜日8 = 水曜日16 = 木曜日32 = 金曜日64 = 土曜日 |
16 (月単位) |
月の @freq_interval 日。 |
32 (月単位の相対) |
@freq_interval は次のいずれかです。1 = 日曜日2 = 月曜日3 = 火曜日4 = 水曜日5 = 木曜日6 = 金曜日7 = 土曜日8 = 日9 = 平日10 = 週末 |
64(SQL Server エージェント サービスの起動時) |
@freq_interval は使用されません。 |
128 |
@freq_interval は使用されません。 |
[ @freq_subday_type = ] freq_subday_type
@freq_subday_intervalの単位を指定します。 @freq_subday_type は int であり、次のいずれかの値を指定できます。
| 値 | 説明 (単位) |
|---|---|
0x1 |
指定した時刻 |
0x2 |
秒 |
0x4 |
分 |
0x8 |
時間 |
[ @freq_subday_interval = ] freq_subday_interval
ジョブの各実行間に発生する @freq_subday_type 期間の数。 @freq_subday_interval は int で、既定値は 0 です。
[ @freq_relative_interval = ] freq_relative_interval
さらに、@freq_typeが 32 (毎月の相対) に設定されている場合の@freq_intervalを定義します。
@freq_relative_interval は int で、次のいずれかの値を指定できます。
| 値 | 説明 (単位) |
|---|---|
1 |
最初 |
2 |
Second |
4 |
Third |
8 |
4 番目 |
16 |
最後 |
@freq_relative_interval は、間隔の発生を示します。 たとえば、 @freq_relative_interval が 2 に設定され、 @freq_type が 32 に設定され、 @freq_interval が 3 に設定されている場合、スケジュールされたジョブは毎月の第 2 火曜日に発生します。
[ @freq_recurrence_factor = ] freq_recurrence_factor
ジョブのスケジュールされた実行の間の週または月数。 @freq_recurrence_factor は int で、既定値は 0 です。 @freq_recurrence_factor は、 @freq_type が 8、 16、または 32に設定されている場合にのみ使用されます。
[ @active_start_date = ] active_start_date
ジョブの実行を開始できる日付。 @active_start_date は int で、既定値は NULL です。 日付は yyyyMMddとして書式設定されます。 @active_start_dateが設定されている場合、日付は19900101以上である必要があります。
スケジュールが作成されたら、開始日を確認し、正しい日付であることを確認します。 詳細については、「 ジョブへのスケジュールの作成とアタッチ」の「開始日のスケジュール設定」セクションを参照してください。
[ @active_end_date = ] active_end_date
ジョブの実行を停止できる日付。 @active_end_date は int で、既定値は 99991231 です。 日付は yyyyMMddとして書式設定されます。
[ @active_start_time = ] active_start_time
ジョブの実行を開始する @active_start_date から @active_end_date までの任意の日の時刻。 @active_start_time は int で、既定値は 000000 です。 時刻は 24 時間制で HHmmss として書式設定されます。
[ @active_end_time = ] active_end_time
ジョブの実行を終了する active_start_date から @active_end_date までの任意の日の時刻。 @active_end_time は int で、既定値は 235959 です。 時刻は 24 時間制で HHmmss として書式設定されます。
[ @schedule_id = ] schedule_id OUTPUT
スケジュールが正常に作成された場合は、スケジュールに割り当てられた ID 番号をスケジュールします。 @schedule_id は、 int 型の OUTPUT パラメーターです。
[ @automatic_post = ] automatic_post
単に情報を示すためだけに特定されます。 サポートされていません。 将来の互換性は保証されません。
[ @schedule_uid = ] 'schedule_uid' OUTPUT
スケジュールの一意識別子を指定します。 @schedule_uid は、 uniqueidentifier 型の OUTPUT パラメーターです。
リターン コードの値
0 (成功) または 1 (失敗)。
結果セット
ありません。
解説
ジョブ スケジュールをジョブとは別に管理できるようになりました。 ジョブにスケジュールを追加するには、 sp_add_schedule を使用してスケジュールを作成し、スケジュールをジョブにアタッチする sp_attach_schedule します。
アクセス許可
この手順では EXECUTE アクセス許可を付与できますが、これらのアクセス許可は SQL Server のアップグレード中にオーバーライドされる可能性があります。
他のユーザーには、msdb データベース内の次SQL Server エージェント固定データベース ロールのいずれかを付与する必要があります。
- SQLAgentUserRole
- SQLAgentReaderRole
- SQLAgentOperatorRole
これらのロールの権限の詳細については、「 SQL Server エージェントの固定データベース ロール」を参照してください。
例
次の例では、毎週土曜日の午前 2 時に実行されるジョブ スケジュールを SaturdayReports に割り当てます。
EXEC msdb.dbo.sp_add_jobschedule
@job_name = N'SaturdayReports', -- Job name
@name = N'Weekly_Sat_2AM', -- Schedule name
@freq_type = 8, -- Weekly
@freq_interval = 64, -- Saturday
@freq_recurrence_factor = 1, -- every week
@active_start_time = 20000 -- 2:00 AM