sp_stop_job (Transact-SQL)
指示 SQL Server 代理停止执行作业。
语法
sp_stop_job
[@job_name =] 'job_name'
| [@job_id =] job_id
| [@originating_server =] 'master_server'
| [@server_name =] 'target_server'
参数
- [ @job_name =] 'job_name'
要停止的作业的名称。job_name 的数据类型为 sysname,默认值为 NULL。
- [ @job_id =] job_id
要停止的作业的标识号。job_id 的数据类型为 uniqueidentifier,默认值为 NULL。
[ @originating_server =] 'master_server'
主服务器的名称。如果指定主服务器的名称,则将停止所有多服务器作业。master_server 的数据类型为 nvarchar(128),默认值为 NULL。仅当在目标服务器上调用 sp_stop_job 时才指定此参数。注意: 只能指定前三个参数之一。
- [ @server_name =] 'target_server'
要在其上停止多服务器作业的特定目标服务器的名称。target_server 的数据类型为 nvarchar(128),默认值为 NULL。仅当在主服务器上为多服务器作业调用 sp_stop_job 时才指定此参数。
返回代码值
0(成功)或 1(失败)
结果集
无
备注
如果作业当前正在执行 CmdExec 类型的步骤,则将强制提前结束正在运行的进程(例如 MyProgram.exe)。提前结束可能导致不可预知的行为,如进程正在使用的文件保持为打开状态。因此,如果作业包含 CmdExec 类型的步骤,则应在极特殊的情况下才使用 sp_stop_job。
权限
默认情况下,只有 sysadmin 固定服务器角色的成员才可以执行此存储过程。其他用户必须被授予 msdb 数据库中下列 SQL Server 代理固定数据库角色的权限之一:
- SQLAgentUserRole
- SQLAgentReaderRole
- SQLAgentOperatorRole
有关这些角色的权限的详细信息,请参阅 SQL Server 代理固定数据库角色。
SQLAgentUserRole 和 SQLAgentReaderRole 的成员只能停止他们所拥有的作业。SQLAgentOperatorRole 的成员可以停止所有本地作业,包括其他用户所拥有的本地作业。sysadmin 的成员可以停止所有本地作业和多服务器作业。
示例
以下示例将停止一个名为 Weekly Sales Data Backup
的作业。
USE msdb ;
GO
EXEC dbo.sp_stop_job
N'Weekly Sales Data Backup' ;
GO
请参阅
参考
sp_delete_job (Transact-SQL)
sp_help_job (Transact-SQL)
sp_start_job (Transact-SQL)
sp_update_job (Transact-SQL)
系统存储过程 (Transact-SQL)