Skip to content

sp-changedistributiondb-transact-sql.md

Latest commit

 

History

History
80 lines (57 loc) · 2.54 KB

sp-changedistributiondb-transact-sql.md

File metadata and controls

80 lines (57 loc) · 2.54 KB
title sp_changedistributiondb (Transact-SQL)
description sp_changedistributiondb changes the properties of the distribution database.
author markingmyname
ms.author maghan
ms.reviewer randolphwest
ms.date 06/23/2025
ms.service sql
ms.subservice replication
ms.topic reference
f1_keywords
sp_changedistributiondb_TSQL
sp_changedistributiondb
helpviewer_keywords
sp_changedistributiondb
dev_langs
TSQL

sp_changedistributiondb (Transact-SQL)

[!INCLUDE SQL Server SQL MI]

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

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

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

:::code language="sql" source="../replication/codesnippet/tsql/sp-changedistributiondb-_1.sql":::

Permissions

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

Related content