Skip to content

sys-sp-cdc-enable-db-transact-sql.md

Latest commit

 

History

History
81 lines (64 loc) · 3.43 KB

sys-sp-cdc-enable-db-transact-sql.md

File metadata and controls

81 lines (64 loc) · 3.43 KB
title sys.sp_cdc_enable_db (Transact-SQL) | Microsoft Docs
ms.custom
ms.date 03/15/2017
ms.prod sql-non-specified
ms.prod_service database-engine
ms.service
ms.component system-stored-procedures
ms.reviewer
ms.suite sql
ms.technology
database-engine
ms.tgt_pltfrm
ms.topic language-reference
f1_keywords
sp_cdc_enable_db_TSQL
sp_cdc_enable_db
sys.sp_cdc_enable_db
sys.sp_cdc_enable_db_TSQL
dev_langs
TSQL
helpviewer_keywords
sys.sp_cdc_enable_db
change data capture [SQL Server], enabling databases
sp_cdc_enable_db
ms.assetid 176d83b3-493d-43cd-800e-aa123c3bdf17
caps.latest.revision 27
author edmacauley
ms.author edmaca
manager craigg
ms.workload Inactive

sys.sp_cdc_enable_db (Transact-SQL)

[!INCLUDEtsql-appliesto-ss2008-xxxx-xxxx-xxx-md]

Enables change data capture for the current database. This procedure must be executed for a database before any tables can be enabled for change data capture in that database. Change data capture records insert, update, and delete activity applied to enabled tables, making the details of the changes available in an easily consumed relational format. Column information that mirrors the column structure of a tracked source table is captured for the modified rows, along with the metadata needed to apply the changes to a target environment.

Important

Change data capture is not available in every edition of [!INCLUDEmsCoName][!INCLUDEssNoVersion]. For a list of features that are supported by the editions of [!INCLUDEssNoVersion], see Features Supported by the Editions of SQL Server 2016.
Applies to: [!INCLUDEssNoVersion] ([!INCLUDEssKatmai] through current version).

Topic link icon Transact-SQL Syntax Conventions

Syntax

  
sys.sp_cdc_enable_db

Return Code Values

0 (success) or 1 (failure)

Result Sets

None

Remarks

Change data capture cannot be enabled on system databases or distribution databases.

sys.sp_cdc_enable_db creates the change data capture objects that have database wide scope, including meta data tables and DDL triggers. It also creates the cdc schema and cdc database user and sets the is_cdc_enabled column for the database entry in the sys.databases catalog view to 1.

Permissions

Requires membership in the sysadmin fixed server role.

Examples

The following example enables change data capture.

USE AdventureWorks2012;  
GO  
EXECUTE sys.sp_cdc_enable_db;  
GO

See Also

sys.sp_cdc_disable_db (Transact-SQL)