sp_help_schedule (TRANSACT-SQL)sp_help_schedule (Transact-SQL)

適用対象: yesSQL Server noAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse APPLIES TO: yesSQL Server noAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse

スケジュールの詳細についての情報を一覧表示します。Lists information about schedules.

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

構文Syntax

  
sp_help_schedule   
     [ @schedule_id = ] id ,  
     [ @schedule_name = ] 'schedule_name'   
     [ , [ @attached_schedules_only = ] attached_schedules_only ]  
     [ , [ @include_description = ] include_description ]  

引数Arguments

[ @schedule_id = ] id 一覧表示するスケジュールの識別子。[ @schedule_id = ] id The identifier of the schedule to list. schedule_nameint、既定値はありません。schedule_name is int, with no default. いずれかschedule_idまたはschedule_name指定することがあります。Either schedule_id or schedule_name may be specified.

[ @schedule_name = ] 'schedule_name' 一覧表示するスケジュールの名前。[ @schedule_name = ] 'schedule_name' The name of the schedule to list. schedule_namesysname、既定値はありません。schedule_name is sysname, with no default. いずれかschedule_idまたはschedule_name指定することがあります。Either schedule_id or schedule_name may be specified.

[ @attached_schedules_only = ] attached_schedules_only ] ジョブに接続されているスケジュールのみを表示するかどうかを指定します。[ @attached_schedules_only = ] attached_schedules_only ] Specifies whether to show only schedules that a job is attached to. attached_schedules_onlyビット、既定値は0します。attached_schedules_only is bit, with a default of 0. ときにattached_schedules_only0、すべてのスケジュールが表示されます。When attached_schedules_only is 0, all schedules are shown. ときにattached_schedules_only1ジョブにアタッチされているスケジュールのみが結果セットに含まれています。When attached_schedules_only is 1, the result set contains only schedules that are attached to a job.

[ @include_description = ] include_description 結果セットに説明を含めるかどうかを指定します。[ @include_description = ] include_description Specifies whether to include descriptions in the result set. include_descriptionビット、既定値は0します。include_description is bit, with a default of 0. ときにinclude_description0schedule_description結果セットの列にはプレース ホルダーが含まれています。When include_description is 0, the schedule_description column of the result set contains a placeholder. ときにinclude_description1、結果セットのスケジュールの説明が含まれます。When include_description is 1, the description of the schedule is included in the result set.

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

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

結果セットResult Sets

このプロシージャでは、次の結果セットが返されます。This procedure returns the following result set:

列名Column name データ型Data type 説明Description
schedule_idschedule_id intint スケジュールの識別番号。Schedule identifier number.
schedule_uidschedule_uid uniqueidentifieruniqueidentifier スケジュールの識別子。Identifier for the schedule.
schedule_nameschedule_name sysnamesysname スケジュールの名前。Name of the schedule.
enabledenabled intint スケジュールが有効かどうか (1) または有効になっていません (0)。Whether the schedule enabled (1) or not enabled (0).
freq_typefreq_type intint ジョブが実行されることを示す値。Value indicating when the job is to be executed.

1 = 1 回1 = Once

4 = 毎日4 = Daily

8 = 毎週8 = Weekly

16毎月を =16 = Monthly

32を基準とする、毎月を =、 freq_interval32 = Monthly, relative to the freq_interval

64 SQLServerAgent サービスの起動時に実行を = です。64 = Run when SQLServerAgent service starts.
freq_intervalfreq_interval intint 日のジョブを実行するとします。Days when the job is executed. 値の値に依存freq_typeします。The value depends on the value of freq_type. 詳細については、次を参照してください。 sp_add_schedule (TRANSACT-SQL)します。For more information, see sp_add_schedule (Transact-SQL).
freq_subday_typefreq_subday_type intint 単位freq_subday_intervalします。Units for freq_subday_interval. 詳細については、次を参照してください。 sp_add_schedule (TRANSACT-SQL)します。For more information, see sp_add_schedule (Transact-SQL).
freq_subday_intervalfreq_subday_interval intint freq_subday_typeにジョブの各実行間に発生する期間。Number of freq_subday_type periods to occur between each execution of the job. 詳細については、次を参照してください。 sp_add_schedule (TRANSACT-SQL)します。For more information, see sp_add_schedule (Transact-SQL).
freq_relative_intervalfreq_relative_interval intint 定期ジョブのfreq_interval各月にします。Scheduled job's occurrence of the freq_interval in each month. 詳細については、次を参照してください。 sp_add_schedule (TRANSACT-SQL)します。For more information, see sp_add_schedule (Transact-SQL).
freq_recurrence_factorfreq_recurrence_factor intint 定期ジョブの実行間隔 (月単位)。Number of months between the scheduled execution of the job.
active_start_dateactive_start_date intint スケジュールをアクティブにした日付。Date the schedule is activated.
active_end_dateactive_end_date intint スケジュールの終了日。End date of the schedule.
active_start_timeactive_start_time intint スケジュールの開始時刻。Time of the day the schedule starts.
active_end_timeactive_end_time intint スケジュールを終了する時刻。Time of the day schedule ends.
date_createddate_created datetimedatetime スケジュールを作成した日付。Date the schedule is created.
schedule_descriptionschedule_description nvarchar (4000)nvarchar(4000) 英語によるスケジュールの説明 (必要な場合)。An English description of the schedule (if requested).
job_countjob_count intint このスケジュールを参照するジョブの数を返します。Returns how many jobs reference this schedule.

コメントRemarks

パラメーターが指定されていないときにsp_help_scheduleインスタンスのすべてのスケジュール情報を一覧表示します。When no parameters are provided, sp_help_schedule lists information for all schedules in the instance.

アクセス許可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.

メンバーのSQLAgentUserRole所有しているスケジュールのみを表示できます。Members of SQLAgentUserRole can only view the schedules that they own.

使用例Examples

A.A. インスタンスのすべてのスケジュールに関する情報を一覧表示するListing information for all schedules in the instance

次の例では、インスタンスのすべてのスケジュールに関する情報を一覧表示します。The following example lists information for all schedules in the instance.

USE msdb ;  
GO  
  
EXEC dbo.sp_help_schedule ;  
GO  

B.B. 特定のスケジュールに関する情報を一覧表示します。Listing information for a specific schedule

次の例では、NightlyJobs というスケジュールに関する情報を一覧表示します。The following example lists information for the schedule named NightlyJobs.

USE msdb ;  
GO  
  
EXEC dbo.sp_help_schedule  
    @schedule_name = N'NightlyJobs' ;  
GO  

参照See Also

sp_add_schedule (TRANSACT-SQL) sp_add_schedule (Transact-SQL)
sp_attach_schedule (TRANSACT-SQL) sp_attach_schedule (Transact-SQL)
sp_delete_schedule (TRANSACT-SQL) sp_delete_schedule (Transact-SQL)
sp_detach_schedule (TRANSACT-SQL)sp_detach_schedule (Transact-SQL)