sp_delete_job (Transact-SQL)

适用于: SQL Server Azure SQL 托管实例

从SQL Server 代理服务中删除作业。

Transact-SQL 语法约定

语法

sp_delete_job
    [ [ @job_id = ] 'job_id' ]
    [ , [ @job_name = ] N'job_name' ]
    [ , [ @originating_server = ] N'originating_server' ]
    [ , [ @delete_history = ] delete_history ]
    [ , [ @delete_unused_schedule = ] delete_unused_schedule ]
[ ; ]

参数

[ @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;不能指定两者。

[ @originating_server = ] N'originating_server'

标识为仅供参考。 不支持。 不保证以后的兼容性。

[ @delete_history = ] delete_history

指定是否删除作业的历史记录。 @delete_history为,默认值为 1.

  • 当@delete_history1,将删除作业的作业历史记录。
  • 当@delete_history0,不会删除作业历史记录。

删除作业且不会删除历史记录时,作业的历史信息不会显示在SQL Server 代理图形用户界面作业历史记录中,但信息仍驻留在sysjobhistory数据库中的msdb表中。

[ @delete_unused_schedule = ] delete_unused_schedule

指定是否删除附加到此作业的计划(如果未附加到任何其他作业)。 @delete_unused_schedule为,默认值为 1.

  • 当@delete_unused_schedule1,如果没有其他作业引用计划,则会删除附加到此作业的计划。
  • 当@delete_unused_schedule0,不会删除计划。

返回代码值

0(成功)或 1(失败)。

结果集

无。

注解

@originating_server参数保留供内部使用。

@delete_unused_schedule参数通过自动删除未附加到任何作业的计划,提供与以前版本的 SQL Server 的向后兼容性。 此参数默认为向后兼容的行为。 若要保留未附加到作业的计划,必须将该值 0 作为 @delete_unused_schedule 参数提供。

SQL Server Management Studio 为管理作业提供了一种图形化的简便方法,建议使用此方法来创建和管理作业基础结构。

此存储过程无法删除维护计划,也不能删除属于维护计划的一部分的作业。 请改用 SQL Server Management Studio 删除维护计划。

此存储过程与用于Azure SQL 数据库Azure 弹性作业服务的类似对象共享名称sp_delete_job。 有关弹性作业版本的信息,请参阅jobs.sp_delete_job(Azure 弹性作业)。

权限

此存储过程由 db_owner 角色拥有。 你可以为任何用户授予 EXECUTE 权限,但这些权限可能会在 SQL Server 升级期间被重写。

其他用户必须被授予数据库中以下SQL Server 代理固定数据库角色msdb之一:

  • SQLAgentUserRole
  • SQLAgentReaderRole
  • SQLAgentOperatorRole

有关这些角色的权限的详细信息,请参阅 SQL Server 代理固定数据库角色

sysadmin 固定服务器角色的成员可以执行sp_delete_job以删除任何作业。 不是 sysadmin 固定服务器角色成员的用户只能删除该用户拥有的作业。

示例

以下示例删除作业 NightlyBackups

USE msdb;
GO

EXEC sp_delete_job
    @job_name = N'NightlyBackups';
GO