sp-changedistributor-property-transact-sql.md

title	description	author	ms.author	ms.reviewer	ms.date	ms.service	ms.subservice	ms.topic	f1_keywords	helpviewer_keywords	dev_langs
sp_changedistributor_property (Transact-SQL)	sp_changedistributor_property changes the properties of the Distributor.	markingmyname	maghan	randolphwest	07/05/2024	sql	replication	reference	sp_changedistributor_property_TSQL sp_changedistributor_property	sp_changedistributor_property	TSQL

sp_changedistributor_property (Transact-SQL)

[!INCLUDE SQL Server SQL MI]

Changes the properties of the Distributor. 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_changedistributor_property
    [ [ @property = ] N'property' ]
    [ , [ @value = ] N'value' ]
[ ; ]

Arguments

[ @property = ] N'property'

The property for a given Distributor. @property is sysname, and can be one of these values.

Value	Description
heartbeat_interval	Maximum number of minutes that an agent can run without logging a progress message.
NULL (default)	All available @property values are printed.

[ @value = ] N'value'

The value for the given Distributor property. @value is nvarchar(255), with a default of NULL.

Return code values

0 (success) or 1 (failure).

Remarks

sp_changedistributor_property is used in all types of replication.

Examples

:::code language="sql" source="../replication/codesnippet/tsql/sp-changedistributor-pro_1.sql":::

Permissions

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

Related content

• View and Modify Distributor and Publisher Properties
• sp_adddistributor (Transact-SQL)
• sp_dropdistributor (Transact-SQL)
• sp_helpdistributor (Transact-SQL)
• Replication stored procedures (Transact-SQL)