sys.sp_cdc_start_job (Transact-SQL)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

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

||
|-|
|Applies to: SQL Server ( SQL Server 2008 through current version).|

Topic link icon Transact-SQL Syntax Conventions

Syntax


sys.sp_cdc_start_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_start_job can be used by an administrator to explicitly start either the capture job or the cleanup job.

Permissions

Requires membership in the db_owner fixed database role.

Examples

A. Starting a capture job

The following example starts the capture job for the AdventureWorks2012 database. Specifying a value for job_type is not required because the default job type is capture.

USE AdventureWorks2012;  
GO  
EXEC sys.sp_cdc_start_job;  
GO  

B. Starting a cleanup job

The following example starts a cleanup job for the AdventureWorks2012 database.

USE AdventureWorks2012;  
GO  
EXEC sys.sp_cdc_start_job @job_type = N'cleanup';  

See Also

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