sp_changedistributiondb (T-SQL)

Updates the properties of the distribution database.

Syntax

sp_changedistributiondb [@database =] 'database'
    [,[@property =] 'property'] [,[@value =] 'value']

Arguments

[@database =] 'database'

Is the name of the database. database is sysname, with no default.

[@property =] 'property'

Is the property to change for the given database. property is sysname, and can be one of these values.

 

Value	Description
history_retention	History table retention period.
max_distretention	Maximum distribution retention period. This value must be greater than or equal to the retention period of all transactional publications in the distribution database.
min_distretention	Minimum distribution retention period.
NULL (default)	All available property values are printed.

[@value =] 'value'

Is the new value for the specified property. value is nvarchar(255), with a default of NULL.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_changedistributiondb is used in all types of replication.

Permissions

Only members of the sysadmin fixed server role can execute sp_changedistributiondb.

See Also