sys.sp_cdc_enable_db (Transact-SQL)

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

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 Microsoft SQL Server. For a list of features that are supported by the editions of SQL Server, see Features Supported by the Editions of SQL Server 2016.

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)