HistoryRetention Property

SQL-DMO

SQL-DMO

HistoryRetention Property

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

Applies To
DistributionDatabase Object
Syntax

object.HistoryRetention [= value]

Parts

object

Expression that evaluates to an object in the Applies To list.

value

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.