sys.sp_help_change_feed (Transact-SQL)

Applies to: SQL Server 2022 (16.x) Azure SQL Database Azure Synapse Analytics Microsoft Fabric

Monitors the current configuration of the change feed.

This system stored procedure is used for:

Syntax

Transact-SQL syntax conventions

EXECUTE sys.sp_help_change_feed;

Result set

Column name Data type Description
table_group_id uniqueidentifier The unique identifier of the table group.
table_group_name nvarchar(140) The name of the table group.
destination_location nvarchar(512) URL string of the landing zone folder.
destination_credential sysname The credential name to access the landing zone.
workspace_id nvarchar(247) The related Synapse workspace Azure resource ID.
synapse_workgroup_name nvarchar(50) The related Synapse workspace name.
schema_name sysname The database schema name of the change feed table.
table_name sysname The name of the change feed table.
table_id uniqueidentifier The unique identifier for the change feed table. Generated during change feed setup workflow.
table_object_id int The object ID of the change feed table.
state tinyint The state of the change feed table. Valid state values: 1 - Enabled. 2 - Exporting. 3 - Exported. 4 - Active. 5 - Disabled. 6 - Pending Disablement.
version binary(10) The version of the change feed table.
snapshot_phase tinyint Phase of the current snapshot which progresses from one to six.
1 - ABORT_PRIOR_SNAPSHOT_IF_ANY
2 - SET_TABLEVERSIONLSN
3 - EXPORT_SCHEMA_FILE
4 - EMIT_SNAPSHOT_BEGINENTRY
5 - EXPORT_DATA_FILE
6 - EMIT_SNAPSHOT_ENDENTRY
snapshot_current_phase_time datetime Time when the current snapshot phase started.
snapshot_retry_count int Number of times snapshot has attempted to retry.
snapshot_start_time datetime Start time of snapshot phase
snapshot_end_time datetime End time of snapshot phase
snapshot_row_count int The number of rows of data being exported during the snapshot operation of the change feed table
destination_type int 0 = Azure Synapse Link. 2 = Fabric mirroring.

Permissions

Currently, only a member of the sysadmin server role or db_owner role, or a user with CONTROL database permissions can execute this procedure.

Examples

To check the status of tables and metadata:

EXEC sp_help_change_feed;

For Microsoft Fabric mirrored databases:

For Azure Synapse Link: