sp_helpreplicationoption (Transact-SQL)

Article
02/28/2023

Applies to: SQL Server Azure SQL Managed Instance

Shows the types of replication options enabled for a server. This stored procedure is executed at any server on any database.

Transact-SQL syntax conventions

Syntax

  
sp_helpreplicationoption [ [ @optname =] 'option_name' ]

Arguments

[ @optname = ] 'option_name' Is the name of the replication option to query for. option_name is sysname, with a default of NULL.

Value	Description
transactional	A result set is returned when transactional replication is enabled.
merge	A result set is returned when merge replication is enabled.
NULL (default)	A result set is not returned.

Result Sets

Column name	Data type	Description
optname	sysname	Name of the replication option and can be one of the following: transactional merge
value	bit	Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.
major_version	int	Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.
minor_version	int	Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.
revision	int	Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.
install_failures	int	Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_helpreplicationoption is used to get information about replication options enabled on a particular server. To get information on a particular database, use sp_helpreplicationdboption.

Permissions

Execute permissions default to the public role.