Edit

sys.sp_cdc_stop_job (Transact-SQL)

  • Article

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 = ] N'job_type' ]
[ ; ]

Arguments

[ @job_type = ] N'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 set

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 AdventureWorks2022 database.

USE AdventureWorks2022;
GO

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

Related content