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:

• The Azure Synapse Link feature for SQL Server instances and Azure SQL Database. For more information, see Manage Azure Synapse Link for SQL Server and Azure SQL Database.
• The Fabric Mirrored Database feature for Azure SQL Database. For more information, see Microsoft Fabric mirrored databases (Preview).

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.
version	binary(10)	The version of the change feed table.
snapshot_phase	tinyint	Phase of the current snapshot.
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;

Related content

• sys.sp_help_change_feed_table (Transact-SQL)
• sys.sp_help_change_feed_table_groups (Transact-SQL)
• sys.sp_help_change_feed_settings (Transact-SQL)
• sys.sp_change_feed_configure_parameters (Transact-SQL)
• sys.dm_change_feed_log_scan_sessions (Transact-SQL)
• sys.dm_change_feed_errors (Transact-SQL)

For Microsoft Fabric mirrored databases:

• Microsoft Fabric mirrored databases (Preview)
• Microsoft Fabric mirrored databases monitoring
• Explore data in your Mirrored database using Microsoft Fabric

For Azure Synapse Link:

• What is Azure Synapse Link for SQL?
• Azure Synapse Link for SQL change feed
• Manage Azure Synapse Link for SQL Server and Azure SQL Database
• Troubleshoot: Azure Synapse Link for SQL initial snapshot issues