sp_changedistributor_property (Transact-SQL)

Applies to: SQL Server Azure SQL Managed Instance

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

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


-- Change the heartbeat interval at the Distributor to 5 minutes. 
USE master 
exec sp_changedistributor_property 
    @property = N'heartbeat_interval', 
    @value = 5;
GO

Permissions

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