Edit

Share via

sp_changedistributiondb (Transact-SQL)

  • Article

Applies to: SQL Server Azure SQL Managed Instance

Changes the properties of the distribution database. This stored procedure is executed at the Distributor on any database.

Transact-SQL syntax conventions

Syntax

syntaxsql 
sp_changedistributiondb
    [ @database = ] N'database'
    [ , [ @property = ] N'property' ]
    [ , [ @value = ] N'value' ]
[ ; ]

Arguments

[ @database = ] N'database'

The name of the distribution database. @database is sysname, with no default.

[ @property = ] N'property'

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.
min_distretention Minimum distribution retention period.
NULL (default) All available @property values are printed.

[ @value = ] N'value'

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.

Examples

SQL 
DECLARE @distributionDB AS sysname;
SET @distributionDB = N'distribution';

-- Change the history retention period to 24 hours and the
-- maximum retention period to 48 hours.  
USE distribution
EXEC sp_changedistributiondb @distributionDB, N'history_retention', 24
EXEC sp_changedistributiondb @distributionDB, N'max_distretention', 48
GO

Permissions

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

Related content