Publication.RetentionPeriod Property

Article
12/03/2008

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

public int RetentionPeriod { get; set; }

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

/** @property */
public int get_RetentionPeriod ()

/** @property */
public void set_RetentionPeriod (int value)

public function get RetentionPeriod () : int

public function set RetentionPeriod (value : int)

Property Value

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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms