sp_add_jobschedule (Transact-SQL)sp_add_jobschedule (Transact-SQL)

適用対象: ○SQL Server XAzure SQL Database XAzure SQL Data Warehouse XParallel Data WarehouseAPPLIES TO: yesSQL Server noAzure SQL Database noAzure SQL Data Warehouse noParallel Data Warehouse

ジョブのスケジュールを作成します。Creates a schedule for a job.

トピック リンク アイコン Transact-SQL 構文表記規則Topic link icon Transact-SQL Syntax Conventions

構文Syntax

  
sp_add_jobschedule [ @job_id = ] job_id, | [ @job_name = ] 'job_name', [ @name = ] 'name'  
     [ , [ @enabled = ] enabled_flag ]  
     [ , [ @freq_type = ] frequency_type ]  
     [ , [ @freq_interval = ] frequency_interval ]  
     [ , [ @freq_subday_type = ] frequency_subday_type ]  
     [ , [ @freq_subday_interval = ] frequency_subday_interval ]  
     [ , [ @freq_relative_interval = ] frequency_relative_interval ]  
     [ , [ @freq_recurrence_factor = ] frequency_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 ]  

引数Arguments

[ @job_id = ] job_id スケジュールを追加するジョブのジョブ識別番号。[ @job_id = ] job_id Job identification number of the job to which the schedule is added. job_iduniqueidentifier、既定値はありません。job_id is uniqueidentifier, with no default.

[ @job_name = ] 'job_name' スケジュールを追加するジョブの名前。[ @job_name = ] 'job_name' Name of the job to which the schedule is added. job_namenvarchar (128) 、既定値はありません。job_name is nvarchar(128), with no default.

注意

いずれかjob_idまたはjob_name指定する必要がありますが、両方を指定することはできません。Either job_id or job_name must be specified, but both cannot be specified.

[ @name = ] 'name' スケジュールの名前。[ @name = ] 'name' Name of the schedule. 名前nvarchar (128) 、既定値はありません。name is nvarchar(128), with no default.

[ @enabled = ] enabled_flag スケジュールの現在の状態を示します。[ @enabled = ] enabled_flag Indicates the current status of the schedule. enabled_flagtinyint、既定値は1 (有効)。enabled_flag is tinyint, with a default of 1 (enabled). 場合0スケジュールが有効になっていません。If 0, the schedule is not enabled. スケジュールを無効にすると、ジョブは実行されません。When the schedule is disabled, the job will not be run.

[ @freq_type = ] frequency_type ジョブが実行されるかを示す値。[ @freq_type = ] frequency_type Value that indicates when the job is to be executed. frequency_typeint、既定値は0値は次のいずれかを指定できます。frequency_type is int, with a default of 0, and can be one of the following values:

Value 説明Description
11 1 回。Once
44 毎日。Daily
88 毎週。Weekly
1616 毎月。Monthly
3232 毎月、に対して相対的なfrequency_interval します。Monthly, relative to frequency_interval.
6464 実行するときに、SQL ServerSQL Serverエージェント サービスを開始します。Run when the SQL ServerSQL Server Agent service starts.
128128 コンピューターがアイドル状態のときに実行します。Run when the computer is idle.

[ @freq_interval = ] frequency_interval ジョブを実行する日です。[ @freq_interval = ] frequency_interval Day that the job is executed. frequency_intervalint、既定値は 0 の値に依存してfrequency_type次の表に記載されています。frequency_interval is int, with a default of 0, and depends on the value of frequency_type as indicated in the following table:

Value 効果Effect
1 (1 回)1 (once) frequency_intervalは使用されません。frequency_interval is unused.
4 (毎日)4 (daily) すべてfrequency_interval日。Every frequency_interval days.
8 (毎週)8 (weekly) frequency_interval (OR 論理演算子で結合)、次の 1 つ以上には。frequency_interval is one or more of the following (combined with an OR logical operator):

1 = 日曜日1 = Sunday

2 = 月曜日2 = Monday

4 = 火曜日4 = Tuesday

8 = 水曜日8 = Wednesday

16 = 木曜日16 = Thursday

32 = 金曜日32 = Friday

64 = 土曜日64 = Saturday
16 (毎月)16 (monthly) Frequency_intervalします月の日。On the frequency_interval day of the month.
32 (月単位)32 (monthly relative) frequency_intervalは、次の 1 つです。frequency_interval is one of the following:

1 = 日曜日1 = Sunday

2 = 月曜日2 = Monday

3 = 火曜日3 = Tuesday

4 = 水曜日4 = Wednesday

5 = 木曜日5 = Thursday

6 = 金曜日6 = Friday

7 = 土曜日7 = Saturday

8 = 日8 = Day

9 = 平日9 = Weekday

10 = 土日10 = Weekend day
64 (ときに、SQL ServerSQL Serverエージェント サービスの起動時)64 (when the SQL ServerSQL Server Agent service starts) frequency_intervalは使用されません。frequency_interval is unused.
128128 frequency_intervalは使用されません。frequency_interval is unused.

[ @freq_subday_type = ] frequency_subday_type 単位を指定しますfrequency_subday_intervalします。[ @freq_subday_type = ] frequency_subday_type Specifies the units for frequency_subday_interval. frequency_subday_typeint, で、既定値はありませんは、次の値のいずれかを指定します。frequency_subday_type is int, with no default, and can be one of the following values:

Value 説明 (単位)Description (unit)
0x10x1 指定された時刻At the specified time
0x40x4 MinutesMinutes
0x80x8 HoursHours

[ @freq_subday_interval = ] frequency_subday_intervalfrequency_subday_typeにジョブの各実行間に発生する期間。[ @freq_subday_interval = ] frequency_subday_interval Number of frequency_subday_type periods to occur between each execution of the job. frequency_subday_intervalint、既定値は 0。frequency_subday_interval is int, with a default of 0.

[ @freq_relative_interval = ] frequency_relative_interval さらに定義、 frequency_intervalときfrequency_typeに設定されている32 (月単位)。[ @freq_relative_interval = ] frequency_relative_interval Further defines the frequency_interval when frequency_type is set to 32 (monthly relative).

frequency_relative_intervalint, で、既定値はありませんは、次の値のいずれかを指定します。frequency_relative_interval is int, with no default, and can be one of the following values:

Value 説明 (単位)Description (unit)
11 FirstFirst
22 第 2 週Second
44 サードパーティThird
88 4 番目Fourth
1616 LastLast

frequency_relative_interval相対的な間隔を示します。frequency_relative_interval indicates the occurrence of the interval. たとえば場合、 frequency_relative_intervalに設定されている2frequency_typeに設定されている32、およびfrequency_間隔に設定されている3、スケジュールされたジョブが毎月の第 2 火曜日に発生します。For example, if frequency_relative_interval is set to 2, frequency_type is set to 32, and frequency_interval is set to 3, the scheduled job would occur on the second Tuesday of each month.

[ @freq_recurrence_factor = ] frequency_recurrence_factor 週間隔または月間隔は、ジョブのスケジュール実行の数。[ @freq_recurrence_factor = ] frequency_recurrence_factor Number of weeks or months between the scheduled execution of the job. frequency_recurrence_factor場合にのみ使用がfrequency_typeに設定されている816、または32します。frequency_recurrence_factor is used only if frequency_type is set to 8, 16, or 32. frequency_recurrence_factorint、既定値は 0。frequency_recurrence_factor is int, with a default of 0.

[ @active_start_date = ] active_start_date どのジョブ実行を開始できる日付。[ @active_start_date = ] active_start_date Date on which job execution can begin. active_start_dateint、既定値はありません。active_start_date is int, with no default. 日付は yyyymmdd です。The date is formatted as YYYYMMDD. 場合active_start_dateが設定された場合、日付は 19900101 以上する必要があります。If active_start_date is set, the date must be greater than or equal to 19900101.

スケジュールを作成した後は、開始日を確認し、正しい日付であることを確認します。After the schedule is created, review the start date and confirm that it is the correct date. 詳細については、「開始日のスケジュール設定」セクションを参照してくださいの作成とジョブ スケジュールをアタッチします。For more information, see the section "Scheduling Start Date" in Create and Attach Schedules to Jobs.

[ @active_end_date = ] active_end_date どのジョブ実行を停止できる日付。[ @active_end_date = ] active_end_date Date on which job execution can stop. active_end_dateint、既定値はありません。active_end_date is int, with no default. 日付は yyyymmdd です。The date is formatted as YYYYMMDD.

[ @active_start_time = ] active_start_time 間の日で時間active_start_dateactive_end_dateジョブの実行を開始します。[ @active_start_time = ] active_start_time Time on any day between active_start_date and active_end_date to begin job execution. active_start_timeint、既定値はありません。active_start_time is int, with no default. 時間は 24 時間制の hhmmss 形式で指定として書式設定します。The time is formatted as HHMMSS on a 24-hour clock.

[ @active_end_time = active_end_time_ 間の日で時間active_start_dateactive_end_dateジョブ実行を終了します。[ @active_end_time = active_end_time_ Time on any day between active_start_date and active_end_date to end job execution. active_end_timeint、既定値はありません。active_end_time is int, with no default. 時間は 24 時間制の hhmmss 形式で指定として書式設定します。The time is formatted as HHMMSS on a 24-hour clock.

[ @schedule_id = schedule_idOUTPUT 正常に作成された場合に、スケジュールに割り当てられる id 番号をスケジュールします。[ @schedule_id = schedule_idOUTPUT Schedule identification number assigned to the schedule if it is created successfully. schedule_id型の output 変数は、 int、既定値はありません。schedule_id is an output variable of type int, with no default.

[ @schedule_uid = ] _schedule_uidOUTPUT スケジュールの一意の識別子。[ @schedule_uid = ] _schedule_uidOUTPUT A unique identifier for the schedule. schedule_uid型の変数は、 uniqueidentifierします。schedule_uid is a variable of type uniqueidentifier.

リターン コードの値Return Code Values

0 (成功) または 1 (失敗)0 (success) or 1 (failure)

結果セットResult Sets

なしNone

コメントRemarks

ジョブのスケジュールは、ジョブとは無関係に管理できるようにします。Job schedules can now be managed independently of jobs. スケジュールをジョブに追加するには、使用sp_add_scheduleスケジュールを作成してsp_attach_scheduleスケジュールをジョブにアタッチします。To add a schedule to a job, use sp_add_schedule to create the schedule and sp_attach_schedule to attach the schedule to a job.

アクセス許可Permissions

既定では、このストアド プロシージャを実行できるのは、 sysadmin 固定サーバー ロールのメンバーです。By default, members of the sysadmin fixed server role can execute this stored procedure. 他のユーザーには、 SQL ServerSQL Server msdb データベースの次のいずれかの エージェント固定データベース ロールが許可されている必要があります。Other users must be granted one of the following SQL ServerSQL Server Agent fixed database roles in the msdb database:

  • SQLAgentUserRoleSQLAgentUserRole

  • SQLAgentReaderRoleSQLAgentReaderRole

  • SQLAgentOperatorRoleSQLAgentOperatorRole

これらのロールの権限の詳細については、「 SQL Server エージェントの固定データベース ロール」を参照してください。For details about the permissions of these roles, see SQL Server Agent Fixed Database Roles.

Example

次の例では、ジョブのスケジュールをSaturdayReports毎週土曜日の午前 2 時に実行します。The following example assigns a job schedule to SaturdayReports which will execute every Saturday at 2:00 AM.

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

関連項目See Also

作成し、スケジュールをジョブにアタッチ Create and Attach Schedules to Jobs
ジョブのスケジュール Schedule a Job
スケジュールを作成します。 Create a Schedule
SQL Server エージェント ストアド プロシージャ(TRANSACT-SQL) SQL Server Agent Stored Procedures (Transact-SQL)
sp_add_schedule (TRANSACT-SQL) sp_add_schedule (Transact-SQL)
sp_update_schedule (TRANSACT-SQL) sp_update_schedule (Transact-SQL)
sp_delete_schedule (TRANSACT-SQL) sp_delete_schedule (Transact-SQL)
sp_help_schedule (TRANSACT-SQL) sp_help_schedule (Transact-SQL)
sp_attach_schedule (Transact-SQL)sp_attach_schedule (Transact-SQL)