sp_helpdistributor (Transact-SQL)

适用于:SQL ServerAzure SQL 托管实例

列出有关分发服务器、分发数据库、工作目录和SQL Server 代理用户帐户的信息。 该存储过程在发布服务器上对发布数据库或任何数据库执行。

Transact-SQL 语法约定

语法

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 ]
    [ , [ @publisher_type = ] 'publisher_type' OUTPUT ]
[ ; ]

参数

[ @distributor = ] 'distributor' OUTPUT

分发服务器的名称。 @distributor为 sysname,默认值%为 ,这是返回结果集的唯一值。

[ @distribdb = ] 'distribdb' OUTPUT

分发数据库的名称。 @distribdb是 sysname,默认值%为 ,这是返回结果集的唯一值。

[ @directory = ] 'directory' OUTPUT

工作目录。 @directory为 nvarchar(255),默认值%为 ,这是返回结果集的唯一值。

[ @account = ] 'account' OUTPUT

Microsoft Windows 用户帐户。 @account为 nvarchar(255),默认值%为 ,这是返回结果集的唯一值。

[ @min_distretention = ] min_distretention OUTPUT

最小分发保持期(以小时为单位)。 @min_distretention为 int,默认值为 -1.

[ @max_distretention = ] max_distretention OUTPUT

最大分发保持期(以小时为单位)。 @max_distretention为 int,默认值为 -1.

[ @history_retention = ] history_retention OUTPUT

历史记录保留期(以小时为单位)。 @history_retention为 int,默认值为 -1.

[ @history_cleanupagent = ] 'history_cleanupagent' OUTPUT

历史记录清理代理的名称。 @history_cleanupagentnvarchar(100),默认值 %为 ,这是返回结果集的唯一值。

[ @distrib_cleanupagent = ] 'distrib_cleanupagent' OUTPUT

分发清理代理的名称。 @distrib_cleanupagentnvarchar(100),默认值 %为 ,这是返回结果集的唯一值。

[ @publisher = ] 'publisher'

发布服务器的名称。 @publisher为 sysname,默认值为 NULL.

[ @local = ] 'local'

SQL Server 是否应获取本地服务器值。 @local为 nvarchar(5),默认值为 NULL.

[ @rpcsrvname = ] 'rpcsrvname' OUTPUT

发出远程过程调用的服务器的名称。 @rpcsrvname是 sysname,默认值%为 ,这是返回结果集的唯一值。

[ @publisher_type = ] 'publisher_type' OUTPUT

发布服务器的发布者类型。 @publisher_type是 sysname,默认值为 <>%/>,这是返回结果集的唯一值。

结果集

列名称 数据类型 描述
distributor sysname 分发服务器的名称。
distribution database sysname 分发数据库的名称。
directory nvarchar(255) 工作目录的名称。
account nvarchar(255) Windows 用户帐户的名称。
min distrib retention int 最小分发保持期。
max distrib retention int 最大分发保持期。
history retention int 历史记录保持期。
history cleanup agent nvarchar(100) 历史记录清除代理的名称。
distribution cleanup agent nvarchar(100) 分发清除代理的名称。
rpc server name sysname 远程分发服务器或本地分发服务器的名称。
rpc login name sysname 用于对远程分发服务器的远程过程调用的登录名。
publisher type sysname 发布服务器的类型;可以为下列值之一:

- MSSQL标准版RVER
-甲骨文
- ORACLE 网关

返回代码值

0(成功)或 1(失败)。

注解

sp_helpdistributor用于所有类型的副本 (replica)。

如果在执行 sp_helpdistributor时指定了一个或多个输出参数,则所有设置为 NULL 的输出参数都会在退出时分配值,并且不返回任何结果集。 如果未指定输出参数,则返回结果集。

权限

以下结果集列或输出参数将返回到发布服务器上的 sysadmin 固定服务器角色的成员,并在发布数据库上db_owner固定数据库角色:

结果集列 输出参数
account @account
min distrib retention @min_distretention
max distrib retention @max_distretention
history retention @history_retention
history cleanup agent @history_cleanupagent
distribution cleanup agent @distrib_cleanupagent
rpc login name

以下结果集列返回给分发服务器上的某个发布的发布访问列表中的用户:

  • 目录

以下结果集列返回给所有用户。

结果集列 输出参数
distributor @distributor
distribution database @distribdb
rpc server name @rpcsrvname
publisher type @publisher_type