sys.sp_cdc_get_captured_columns (Transact-SQL)

Applies to: SQL Server

Returns change data capture metadata information for the captured source columns tracked by the specified capture instance. Change data capture isn't available in every edition of SQL Server. For a list of features that are supported by the editions of SQL Server, see Editions and supported features of SQL Server 2022.

Transact-SQL syntax conventions

Syntax

sys.sp_cdc_get_captured_columns
    [ @capture_instance = ] 'capture_instance'
[ ; ]

Arguments

[ @capture_instance = ] 'capture_instance'

The name of the capture instance associated with a source table. @capture_instance is sysname and can't be NULL.

To report on the capture instances for the table, run the sys.sp_cdc_help_change_data_capture stored procedure.

Return code values

0 (success) or 1 (failure).

Result set

Column name	Data type	Description
source_schema	sysname	Name of the source table schema.
source_table	sysname	Name of the source table.
capture_instance	sysname	Name of the capture instance.
column_name	sysname	Name of the captured source column.
column_id	int	ID of the column in the source table.
column_ordinal	int	Position of the column within the source table.
data_type	sysname	Column data type.
character_maximum_length	int	Maximum character length of the character-based column; otherwise, NULL.
numeric_precision	tinyint	Precision of the column if numeric-based; otherwise, NULL.
numeric_precision_radix	smallint	Precision radix of the column if numeric-based; otherwise, NULL.
numeric_scale	int	Scale of the column if numeric-based; otherwise, NULL.
datetime_precision	smallint	Precision of the column if datetime-based; otherwise, NULL.

Remarks

Use sys.sp_cdc_get_captured_columns to obtain column information about the captured columns returned by querying the capture instance query functions cdc.fn_cdc_get_all_changes_<capture_instance> or cdc.fn_cdc_get_net_changes_<capture_instance>. The column names, IDs, and position remain constant for the life of the capture instance. Only the column data type changes when the data type of the underlying source column in the tracked table changes. Columns that are added to or dropped from a source table, have no effect on the captured columns of existing capture instances.

Use sys.sp_cdc_get_ddl_history to obtain information about data definition language (DDL) statements applied to a source table. Any DDL changes that modified the structure of a tracked source column is returned in the result set.

Permissions

Requires membership in the db_owner fixed database role. For all other users, requires SELECT permission on all captured columns in the source table and, if a gating role for the capture instance was defined, membership in that database role. When the caller doesn't have permission to view the source data, the function returns Error 22981 (Object doesn't exist or access is denied.).

Examples

The following example returns information about the captured columns in the HumanResources_Employee capture instance.

USE AdventureWorks2022;
GO

EXECUTE sys.sp_cdc_get_captured_columns
    @capture_instance = N'HumanResources_Employee';
GO

Related content

• sys.sp_cdc_help_change_data_capture (Transact-SQL)