sp_add_schedule (Transact-SQL)

適用対象: SQL ServerAzure SQL Managed Instance

任意の数のジョブで使用できるスケジュールを作成します。

Transact-SQL 構文表記規則

構文

sp_add_schedule
    [ @schedule_name = ] 'schedule_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 = ] 'owner_login_name' ]
    [ , [ @schedule_uid = ] schedule_uid OUTPUT ]
    [ , [ @schedule_id = ] schedule_id OUTPUT ]
    [ , [ @originating_server = ] server_name ] /* internal */
[ ; ]

引数

[ @schedule_name = ] 'schedule_name'

スケジュールの名前です。 @schedule_nameは sysname で、既定値はありません。

[ @enabled = ] が有効

スケジュールの現在の状態を示します。 @enabledは tinyint で、既定値は 1 (有効) です。 場合 0、スケジュールが有効になっていません。 スケジュールが有効になっていない場合、このスケジュールではジョブは実行されません。

[ @freq_type = ] freq_type

ジョブを実行するタイミングを示す値。 @freq_typeは int で、既定値は 0、これらの値のいずれかになります。

Value 説明
1 1 回。
4 毎日
8 週単位
16 月単位
32 月単位(@freq_intervalに対する 相対値)
64 SQL Server エージェント サービスの起動時に実行する
128 コンピューターがアイドル状態のときに実行されます (Azure SQL Managed Instance ではサポートされていません)

[ @freq_interval = ] @freq_interval

ジョブが実行される日数。 @freq_intervalは int で、既定値は 1、@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 (SQLServerAgent サービスの起動時) @freq_intervalは使用されません。
128 @freq_intervalは使用されません。

[ @freq_subday_type = ] freq_subday_type

@freq_subday_intervalの単位を指定します。 @freq_subday_typeは int で、既定値は 0、これらの値のいずれかになります。

Value 説明 (単位)
0x1 指定した時刻
0x2
0x4
0x8 時間

[ @freq_subday_interval = ] freq_subday_interval

ジョブの 各実行の間に発生する@freq_subday_type 期間の数。 @freq_subday_intervalは int で、既定値は 0. 間隔は 10 秒以上である必要があります。 @freq_subday_typeが等しい1場合、@freq_subday_intervalは無視されます。

[ @freq_relative_interval = ] freq_relative_interval

@freq_intervalが 32 (毎月の相対) の場合、ジョブの毎月の@freq_intervalの発生。 @freq_relative_intervalは int で、既定値は 0、これらの値のいずれかになります。 @freq_typeが 32 に等しくない場合、@freq_relative_intervalは無視されます。

Value 説明 (単位)
1 First
2 Second
4 Third
8 4 番目
16 末尾

[ @freq_recurrence_factor = ] freq_recurrence_factor

ジョブのスケジュールされた実行の間の週数または月数。 @freq_recurrence_factorは、@freq_type816または 32. @freq_recurrence_factorは int で、既定値は 0.

[ @active_start_date = ] active_start_date

ジョブの実行を開始できる日付。 @active_start_dateは int で、既定値はNULL今日の日付を示します。 日付は次のように yyyyMMdd書式設定されます。 @active_start_dateが NULL でない場合、日付は19900101以上である必要があります。

スケジュールが作成されたら、開始日を確認し、正しい日付であることを確認します。 詳細については、「スケジュールを作成してジョブにアタッチする」の「開始日のスケジュール設定」セクションを参照してください。

週単位または月単位のスケジュールの場合、エージェントは@active_start_dateが過去の場合は無視し、代わりに現在の日付を使用します。 SQL Server エージェント スケジュールを作成sp_add_scheduleするときに、ジョブの実行を開始する日付であるパラメーター @active_start_dateを指定するオプションがあります。 スケジュールの種類が週単位または月単位で、@active_start_date パラメーターが過去の日付に設定されている場合、@active_start_date パラメーターは無視され、現在の日付が@active_start_date使用されます。

[ @active_end_date = ] active_end_date

ジョブの実行を停止できる日付。 @active_end_dateは int で、既定値は 999912319999 年 12 月 31 日を示します。 として書式設定されます yyyyMMdd

[ @active_start_time = ] active_start_time

ジョブの実行を開始する@active_start_dateから@active_end_dateまでの任意の日の時刻。 @active_start_timeは int で、既定値は 00000024 時間制の午前 12 時 00 分を示し、フォームHHmmssを使用して入力する必要があります。

[ @active_end_time = ] active_end_time

ジョブの実行を終了する@active_start_dateから@active_end_dateまでの任意の日の時刻。 @active_end_timeは int で、既定値は 24 時間制の235959午後 11 時 59 分 59 分を示し、フォームHHmmssを使用して入力する必要があります。

[ @owner_login_name = ] 'owner_login_name'

スケジュールを所有するサーバー プリンシパルの名前。 @owner_login_nameは sysname で、既定値はNULL作成者がスケジュールを所有していることを示します。

[ @schedule_uid = ] schedule_uid OUTPUT

スケジュールの一意識別子を指定します。 @schedule_uidは uniqueidentifier 型の変数です

[ @schedule_id = ] schedule_id OUTPUT

スケジュールの識別子。 @schedule_idは int 型の変数です

[ @originating_server = ] server_name

単に情報を示すためだけに特定されます。 サポートされていません。 将来の互換性は保証されません。

リターン コードの値

0 (成功) または 1 (失敗)。

結果セット

ありません。

解説

SQL Server Management Studio は、簡単かつ直観的な方法でジョブを管理するためのツールで、ジョブ体系の作成および管理に最適です。

アクセス許可

このストアド プロシージャは、db_owner ロールによって所有されています。 任意のユーザーにアクセス許可を付与 EXECUTE できますが、SQL Server のアップグレード中にこれらのアクセス許可がオーバーライドされる可能性があります。

他のユーザーには、データベース内の固定データベース ロールSQL Server エージェント次のいずれかを付与するmsdb必要があります。

  • SQLAgentUserRole
  • SQLAgentReaderRole
  • SQLAgentOperatorRole

これらのロールの権限の詳細については、「 SQL Server エージェントの固定データベース ロール」を参照してください。

A. スケジュールを作成する

次の例では、という名前 RunOnceのスケジュールを作成します。 スケジュールは 1 回のみ、スケジュールが作成された日の 23:30 に実行されます。

USE msdb;
GO

EXEC dbo.sp_add_schedule
    @schedule_name = N'RunOnce',
    @freq_type = 1,
    @active_start_time = 233000;
GO

B. スケジュールを作成し、スケジュールを複数のジョブにアタッチする

次の例では、という名前 NightlyJobsのスケジュールを作成します。 このスケジュールを使用するジョブは、毎日、サーバーの時間が 01:00 になると実行されます。 この例では、ジョブとジョブ BackupDatabase にスケジュールをアタッチします RunReports

Note

この例では、ジョブとジョブBackupDatabaseRunReportsが既に存在することを前提としています。

USE msdb;
GO

EXEC sp_add_schedule
    @schedule_name = N'NightlyJobs',
    @freq_type = 4,
    @freq_interval = 1,
    @active_start_time = 010000;
GO

EXEC sp_attach_schedule
    @job_name = N'BackupDatabase',
    @schedule_name = N'NightlyJobs';
GO

EXEC sp_attach_schedule
    @job_name = N'RunReports',
    @schedule_name = N'NightlyJobs';
GO