sp_update_schedule (Transact-SQL)
適用対象: SQL Server
SQL Server エージェント スケジュールの設定を変更します。
構文
sp_update_schedule
[ [ @schedule_id = ] schedule_id ]
[ , [ @name = ] N'name' ]
[ , [ @new_name = ] N'new_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 ]
[ , [ @owner_login_name = ] N'owner_login_name' ]
[ , [ @automatic_post = ] automatic_post ]
[ ; ]
引数
[ @schedule_id = ] schedule_id
変更するスケジュールの識別子を指定します。 @schedule_id は int で、既定値は NULL
です。
@schedule_idまたは@nameを指定する必要があります。
[ @name = ] N'name'
変更するスケジュールの名前。 @name は sysname で、既定値は NULL
です。
@schedule_idまたは@nameを指定する必要があります。
[ @new_name = ] N'new_name'
スケジュールの新しい名前。 @new_name は sysname で、既定値は NULL
です。 @new_nameがNULL
されると、スケジュールの名前は変更されません。
[ @enabled = ] enabled
スケジュールの現在の状態を示します。 @enabled は tinyint で、既定値は 1
(有効) です。 0
場合、スケジュールは有効になりません。 スケジュールが有効になっていない場合、このスケジュールではジョブは実行されません。
[ @freq_type = ] freq_type
ジョブを実行するタイミングを示す値。 @freq_type は int であり、これらの値のいずれかを指定できます。
Value | 説明 |
---|---|
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 であり、これらの値のいずれかを指定できます。
Value | 説明 (単位) |
---|---|
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 であり、これらの値のいずれかを指定できます。
Value | 説明 (単位) |
---|---|
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
として書式設定されます。
[ @owner_login_name = ] N'owner_login_name'
スケジュールを所有するサーバー プリンシパルの名前。 @owner_login_name は sysname で、既定値は NULL
で、スケジュールが作成者によって所有されていることを示します。
[ @automatic_post = ] automatic_post
単に情報を示すためだけに特定されます。 サポートされていません。 将来の互換性は保証されません。
リターン コードの値
0
(成功) または 1
(失敗)。
解説
スケジュールを使用するすべてのジョブは、すぐに新しい設定を使用します。 ただし、スケジュールを変更しても、現在実行中のジョブは停止しません。
アクセス許可
このストアド プロシージャは、 db_owner ロールによって所有されています。 EXECUTE
アクセス許可は任意のユーザーに付与できますが、SQL Server のアップグレード中にこれらのアクセス許可がオーバーライドされる可能性があります。
他のユーザーには、msdb
データベース内の次SQL Server エージェント固定データベース ロールのいずれかを付与する必要があります。
- SQLAgentUserRole
- SQLAgentReaderRole
- SQLAgentOperatorRole
これらのロールの権限の詳細については、「 SQL Server エージェントの固定データベース ロール」を参照してください。
別のユーザーが所有するスケジュールを変更できるのは、 sysadmin のメンバーだけです。
例
次の例では、 NightlyJobs
スケジュールの有効な状態を 0
に変更し、所有者を terrid
に設定します。
USE msdb;
GO
EXEC dbo.sp_update_schedule
@name = 'NightlyJobs',
@enabled = 0,
@owner_login_name = 'terrid';
GO