HistoryRetention Property

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The HistoryRetention property specifies the number of hours to maintain replication distribution history data.

Syntax

object
.HistoryRetention [=value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list.
  • value
    A positive long integer. The default is 48 hours.

Data Type

Long

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetHistoryRetention(LPDWORD pRetVal);
HRESULT SetHistoryRetention(DWORD NewValue);

Remarks

Installing replication creates a SQL Server Agent job responsible for cleaning the replication history tables. Rows in the tables older than the current hour minus the retention period are targets of the cleaning.

Applies To:

DistributionDatabase Object