• Article

Publication.RetentionPeriod Property

Gets or sets the amount of time before a subscription expires when the subscription is not synchronized with the publication.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

Syntax

'Declaration
Public Property RetentionPeriod As Integer
    Get
    Set
'Usage
Dim instance As Publication
Dim value As Integer

value = instance.RetentionPeriod

instance.RetentionPeriod = value

public int RetentionPeriod { get; set; }

public:
property int RetentionPeriod {
    int get ();
    void set (int value);
}

member RetentionPeriod : int with get, set

function get RetentionPeriod () : int
function set RetentionPeriod (value : int)

Property Value

Type: System.Int32
An Int32 value that specifies the number of hours before the subscription expires if the subscription is not yet synchronized with the publication.

Remarks

For a transactional publication, the retention period is in hours, and the default value of RetentionPeriod is 0 (subscriptions never expire). For a merge publication, the retention period is specified by RetentionPeriodUnit, and the default value of RetentionPeriod is 14 days.

The RetentionPeriod property can only be retrieved by members of the sysadmin fixed server role at the Publisher, by members of the db_owner fixed database role on the publication database, or by users in the publication access list (PAL).

The RetentionPeriod property can only be set by members of the sysadmin fixed server role at the Publisher or by members of the db_owner fixed database role on the publication database. Users in the PAL can set the RetentionPeriod property of an existing publication.

Retrieving the RetentionPeriod property is equivalent to executing sp_helppublication (Transact-SQL) or sp_helpmergepublication (Transact-SQL).

Setting the RetentionPeriod property is equivalent to executing sp_addpublication (Transact-SQL) and sp_changepublication (Transact-SQL) or sp_addmergepublication (Transact-SQL) and sp_changemergepublication (Transact-SQL).

The RetentionPeriod property is available with SQL Server 7.0, SQL Server 2000, and SQL Server 2005.

This namespace, class, or member is supported only in version 2.0 of the .NET Framework.