Transact-SQL Reference

sp_helpdistributor

Lists information about the Distributor, distribution database, working directory, and SQL Server Agent user account. This stored procedure is executed at the Distributor on any database.

Syntax

sp_helpdistributor [ [ @distributor = ] 'distributor' OUTPUT ]
    [ , [ @distribdb = ] 'distribdb' OUTPUT ]
    [ , [ @directory = ] 'directory' OUTPUT ]
    [ , [ @account = ] 'account' OUTPUT ]
    [ , [ @min_distretention = ] min_distretention OUTPUT ]
    [ , [ @max_distretention = ] max_distretention OUTPUT ]
    [ , [ @history_retention = ] history_retention OUTPUT ]
    [ , [ @history_cleanupagent = ] 'history_cleanupagent' OUTPUT ]
    [ , [ @distrib_cleanupagent = ] 'distrib_cleanupagent' OUTPUT ]
    [ , [ @publisher = ] 'publisher' ]
    [ , [ @local = ] 'local' ]
    [ , [ @rpcsrvname = ] 'rpcsrvname' OUTPUT ]

Arguments

[@distributor = ] 'distributor' OUTPUT

Is the name of the Distributor. Distributor is sysname, with a default of %, which is the only value that returns a result set.

[@distribdb = ] 'distribdb' OUTPUT

Is the name of the distribution database. distribdb is sysname, with a default of %, which is the only value that returns a result set.

[@directory = ] 'directory' OUTPUT

Is the working directory. directory is nvarchar(255), with a default of %, which is the only value that returns a result set.

[@account = ] 'account' OUTPUT

Is the Windows® user account. account is nvarchar(255), with a default of %, which is the only value that returns a result set.

[@min_distretention = ] min_distretention OUTPUT

Is the minimum distribution retention period, in hours. min_distretention is int, with a default of -1.

[@max_distretention = ] max_distretention OUTPUT

Is the maximum distribution retention period, in hours. max_distretention is int, with a default of -1.

[@history_retention = ] history_retention OUTPUT

Is the history retention period, in hours. history_retention is int, with a default of -1.

[@history_cleanupagent = ] 'history_cleanupagent' OUTPUT

Is the name of the history cleanup agent. history_cleanupagent is nvarchar(100), with a default of %, which is the only value that returns a result set.

[@distrib_cleanupagent = ] 'distrib_cleanupagent' OUTPUT

Is the name of the history cleanup agent. distrib_cleanupagent is nvarchar(100), with a default of %, which is the only value that returns a result set.

[@publisher = ] 'publisher'

Is the name of the Publisher. publisher is sysname, with a default of NULL.

[@local = ] 'local'

Is whether Microsoft® SQL Server™ should get local server values. local is nvarchar(5), with a default of NULL.

[@rpcsrvname = ] 'rpcsrvname' OUTPUT

Is the name of the server that issues remote procedure calls. rpcsrvname is sysname, with a default of %, which is the only value that returns a result set.

Result Sets

Column name	Data type	Description
Distributor	sysname	Name of the Distributor.
distribution database	sysname	Name of the distribution database.
Directory	nvarchar(255)	Name of the working directory.
Account	nvarchar(255)	Name of the Windows user account.
min distrib retention	int	Minimum distribution retention period.
max distrib retention	int	Maximum distribution retention period.
history retention	int	History retention period.
history cleanup agent	nvarchar(100)	Name of the History Cleanup Agent.
distribution cleanup agent	nvarchar(100)	Name of the Distribution Cleanup Agent.
rpc server name	sysname	Name of the remote or local Distributor.
rpc login name	sysname	Login used for remote procedure calls to the remote Distributor.

If the distribution database is not installed, a NULL value is returned.

Remarks

sp_helpdistributor is used in all types of replication.

Permissions