sys.sp_cdc_help_jobs (Transact-SQL)

Reports information about all change data capture cleanup or capture jobs in the current database.

Topic link icon Transact-SQL Syntax Conventions

Syntax

sys.sp_cdc_help_jobs

Return Code Values

0 (success) or 1 (failure)

Result Sets

Column name

Data type

Description

job_id

uniqueidentifier

The ID of the job.

job_type

nvarchar(20)

The type of job.

maxtrans

int

The maximum number of transactions to process in each scan cycle.

maxtrans is valid only for capture jobs.

maxscans

int

The maximum number of scan cycles to execute in order to extract all rows from the log.

maxscans is valid only for capture jobs.

continuous

bit

A flag indicating whether the capture job is to run continuously (1), or run in one-time mode (0). For more information, see sys.sp_cdc_add_job (Transact-SQL).

continuous is valid only for capture jobs.

pollinginterval

bigint

The number of seconds between log scan cycles.

pollinginterval is valid only for capture jobs.

retention

bigint

The number of minutes that change rows are to be retained in change tables.

retention is valid only for cleanup jobs.

threshold

bigint

The maximum number of delete entries that can be deleted using a single statement on cleanup.

Permissions

Requires membership in the db_owner fixed database role.

Examples

The following example returns information about the defined capture and cleanup jobs for the AdventureWorks2012 database.

USE AdventureWorks2012;
GO
EXEC sys.sp_cdc_help_jobs;
GO

See Also

Reference

dbo.cdc_jobs (Transact-SQL)

sys.sp_cdc_add_job (Transact-SQL)