Skip to content

Latest commit

 

History

History
88 lines (61 loc) · 2.16 KB

sys-sp-cdc-start-job-transact-sql.md

File metadata and controls

88 lines (61 loc) · 2.16 KB
Raw
title description author ms.author ms.reviewer ms.date ms.service ms.subservice ms.topic f1_keywords helpviewer_keywords dev_langs
sys.sp_cdc_start_job (Transact-SQL)
Starts a change data capture cleanup or capture job for the current database.
markingmyname
maghan
randolphwest
06/13/2023
sql
system-objects
reference
sp_cdc_start_job
sp_cdc_start_job_TSQL
sys.sp_cdc_start_job_TSQL
sys.sp_cdc_start_job
sp_cdc_start_job
TSQL

sys.sp_cdc_start_job (Transact-SQL)

[!INCLUDE SQL Server]

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

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

sys.sp_cdc_start_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_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. Start a capture job

The following example starts the capture job for the [!INCLUDE sssampledbobject-md] database. Specifying a value for @job_type isn't required because the default job type is capture.

USE AdventureWorks2022;
GO

EXEC sys.sp_cdc_start_job;
GO

B. Start a cleanup job

The following example starts a cleanup job for the [!INCLUDE sssampledbobject-md] database.

USE AdventureWorks2022;
GO

EXEC sys.sp_cdc_start_job
    @job_type = N'cleanup';

Related content