sp_stop_job

Instructs engine to stop the execution of a job.

Syntax

sp_stop_job
    [@job_name =] 'job_name'
  | [@job_id =] job_id
  | [@originating_server =] 'master_server'
  | [@server_name =] 'target_server'

Arguments

[ @job_name =] ‘job_name’

The name of the job to stop. job_name is sysname, with a default of NULL.

[ @job_id =] job_id

The identification number of the job to stop. job_id is uniqueidentifier, with a default of NULL.

[ @originating_server =] ‘master_server’

The name of the master server. If specified, all multiserver jobs are stopped. master_server is nvarchar(128), with a default of NULL.

Note

Only one of the first three parameters can be specified.

[ @server_name =] ‘target_server’

The name of the specific target server on which to stop a multiserver job. target_server is nvarchar(128), with a default of NULL. Specify this parameter only when calling sp_stop_job at a master server for a multiserver job.

Return Code Values

0 (success) or 1 (failure)

Result Sets

None

Remarks

sp_stop_job sends a stop signal to the database. Some processes can be stopped immediately and some must reach a stable point (or an entry point to the code path) before they can stop. Some long-running Transact-SQL statements such as BACKUP, RESTORE, and some DBCC commands can take a long time to finish. When these are running, it may take a while before the job is canceled. Stopping a job causes a “Job Canceled” entry to be recorded in the job history.

If a job is currently executing a step of type CmdExec or PowerShell, the process being run (for example, MyProgram.exe) is forced to end prematurely. Premature ending can result in unpredictable behavior such as files in use by the process being held open. Consequently, sp_stop_job should be used only in extreme circumstances if the job contains steps of type CmdExec or PowerShell.

Permissions

By default, members of the sysadmin fixed server role can execute this stored procedure.

Members of sysadmin can stop any job.

Examples

The following example stops a job named Weekly Sales Data Backup.

EXEC dbo.sp_stop_job
    N'Weekly Sales Data Backup' ;