sys.sp_cdc_stop_job (Transact-SQL)

Applies to: SQL Server

Stops a change data capture cleanup or capture job for the current database.

Transact-SQL syntax conventions

Syntax

  
sys.sp_cdc_stop_job [ [ @job_type = ] 'job_type' ]  

Arguments

[ [ @job_type = ] 'job_type_' ] Type of job to add. job_type is nvarchar(20) with a default of capture. Valid inputs are capture and cleanup.

Return Code Values

0 (success) or 1 (failure)

Result Sets

None

Remarks

sys.sp_cdc_stop_job can be used by an administrator to explicitly stop either the capture job or the cleanup job.

Permissions

Requires membership in the db_owner fixed database role.

Examples

The following example stops the capture job for the AdventureWorks2012 database.

USE AdventureWorks2012;  
GO  
EXEC sys.sp_cdc_stop_job @job_type = N'capture';  
GO  

See Also

dbo.cdc_jobs (Transact-SQL)
sys.sp_cdc_start_job (Transact-SQL)