删除作业的历史记录。

语法

sp_purge_jobhistory [ @job_name = ] 'job_name' | [ @job_id = ] job_id

参数

[@job_name =] 'job_name'

是要删除其历史记录的作业名。job_name 为 sysname 类型，其默认值为 NULL。必须指定 job_id 或 job_name，但不能两个都指定。

[@job_id =] job_id

是要删除其记录的作业的作业标识号。job_id 为 uniqueidentifier 类型，其默认值为 NULL。必须指定 job_id 或 job_name，但不能两个都指定。

返回代码值

0（成功）或 1（失败）

结果集

无

权限

执行权限默认授予 public 角色。如果未提供参数，那么所有的历史记录都将删除；但是，只有 sysadmin 固定服务器角色的成员有进行这种操作的权限。

示例

A. 删除指定作业的历史记录

下面的示例删除名为 Table Archives 的作业的历史记录。

USE msdb
EXEC sp_purge_jobhistory @job_name = 'Table Archives'

B. 删除所有作业的历史记录

下面的示例不带参数执行此过程以删除所有的历史记录。

USE msdb
EXEC sp_purge_jobhistory