sys.sp_cdc_cleanup_change_table (Transact-SQL)

Removes rows from the change table in the current database based on the specified low_water_mark value. This stored procedure is provided for users who want to directly manage the change table cleanup process. Caution should be used, however, because the procedure affects all consumers of the data in the change table.

Topic link iconTransact-SQL Syntax Conventions

  [ @capture_instance = ] 'capture_instance', 
  [ @low_water_mark = ] low_water_mark ,[ @threshold = ]'delete threshold'

[ @capture_instance = ] 'capture_instance'

Is the name of the capture instance associated with the change table. capture_instance is sysname, with no default, and cannot be NULL.

capture_instance must name a capture instance that exists in the current database.

[ @low_water_mark = ] low_water_mark

Is a log sequence number (LSN) that is to be used as the new low watermark for the capture instance. low_water_mark is binary(10), with no default.

If the value is nonnull, it must appear as the start_lsn value of a current entry in the cdc.lsn_time_mapping table. If other entries in cdc.lsn_time_mapping share the same commit time as the entry identified by the new low watermark, the smallest LSN associated with that group of entries is chosen as the low watermark.

If the value is explicitly set to NULL, the current low watermark for the capture instance is used to define the upper bound for the cleanup operation.

[ @threshold= ] 'delete threshold'

Is the maximum number of delete entries that can be deleted by using a single statement on cleanup. delete_threshold is bigint, with a default of 5000.

0 (success) or 1 (failure)

sys.sp_cdc_cleanup_change_table performs the following operations:

  1. If the @low_water_mark parameter is not NULL, it sets the value of start_lsn for the capture instance to the new low watermark.


    The new low watermark might not be the low watermark that is specified in the stored procedure call. If other entries in the cdc.lsn_time_mapping table share the same commit time, the smallest start_lsn represented in the group of entries is selected as the adjusted low watermark. If the @low_water_mark parameter is NULL or the current low watermark is greater than the new lowwatermark, the start_lsn value for the capture instance is left unchanged.

  2. Change table entries with __$start_lsn values less than the low watermark are then deleted. The delete threshold is used to limit the number of rows deleted in a single transaction. A failure to successfully delete entries is reported, but does not affect any change to the capture instance low watermark that might have been made based on the call.

Use sys.sp_cdc_cleanup_change_table in the following circumstances:

  • The cleanup Agent job reports delete failures.

    An administrator can run this stored procedure explicitly to retry a failed operation. To retry cleanup for a given capture instance, execute sys.sp_cdc_cleanup_change_table, and specify NULL for the @low_water_mark parameter.

  • The simple retention-based policy used by the cleanup Agent job is not adequate.

    Because this stored procedure does cleanup for a single capture instance, it can be used to build a custom cleanup strategy that tailors the rules for cleanup to the individual capture instance.

Requires membership in the db_owner fixed database role.

Community Additions