sp_helpdistpublisher (Transact-SQL)

Article
02/28/2023

Applies to: SQL Server Azure SQL Managed Instance

Returns properties of the Publishers using a Distributor. This stored procedure is executed at the Distributor on any database.

Transact-SQL syntax conventions

Syntax

  
sp_helpdistpublisher [ [ @publisher=] 'publisher']   
    [ , [ @check_user = ] check_user

Arguments

[ @publisher = ] 'publisher' Is the Publisher for which properties are returned. publisher is sysname, with a default of %.

[ @check_user = ] check_user

Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

Result Sets

Column name	Data type	Description
name	sysname	Name of Publisher.
distribution_db	sysname	Distribution database for the specified Publisher.
security_mode	int	Security mode used by replication agents to connect to the Publisher for queued updating subscriptions, or with a non-SQL Server Publisher. 0 = SQL Server Authentication 1 = Windows Authentication
login	sysname	Login name used by replication agents to connect to the Publisher for queued updating subscriptions, or with a non-SQL Server Publisher.
password	nvarchar(524)	Password returned (in simple encrypted form). Password is NULL for users other than sysadmin.
active	bit	Whether a remote Publisher is using the local server as a Distributor: 0 = No 1 = Yes
working_directory	nvarchar(255)	Name of the working directory.
trusted	bit	If the password is required when the Publisher connects to the Distributor. For Microsoft SQL Server 2005 (9.x) and later versions, this should always return 0, which means that the password is required.
thirdparty_flag	bit	Whether the publication is enabled by SQL Server or by a third party application: 0 = SQL Server, Oracle, or Oracle Gateway Publisher. 1 = Publisher has been integrated with SQL Server using a third-party application.
publisher_type	sysname	Type of Publisher; can be one of the following: MSSQLSERVER ORACLE ORACLE GATEWAY
publisher_data_source	nvarchar(4000)	Name of the OLE DB data source on the Publisher.
storage_connection_string	nvarchar(4000)	Storage access key for working directory when distributor or publisher in Azure SQL Database.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_helpdistpublisher is used in all types of replication.

sp_helpdistpublisher will not display the publisher login or password in the result set for non-sysadmin logins.

Permissions

Members of the sysadmin fixed server role may execute sp_helpdistpublisher for any Publisher using the local server as a Distributor. Members of the db_owner fixed database role or the replmonitor role in a distribution database may execute sp_helpdistpublisher for any Publisher using that distribution database. Users in the publication access list for a publication at the specified publisher may execute sp_helpdistpublisher. If publisher is not specified, information is returned for all Publishers that the user has rights to access.