sp_helpdistributor (Transact-SQL)

適用於:SQL ServerAzure SQL 受控執行個體

列出散發者、散發資料庫、工作目錄和 SQL Server Agent 使用者帳戶的相關信息。 這個預存程式會在發行集資料庫或任何資料庫的發行者端執行。

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_cleanupagent是 nvarchar(100),預設值%,這是唯一傳回結果集的值。

[ @distrib_cleanupagent = ] 'distrib_cleanupagent' OUTPUT

散發清除代理程序的名稱。 @distrib_cleanupagent是 nvarchar(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 發行者的類型;可以是下列其中一項:

- MSSQLSERVER
-甲骨文
- ORACLE 閘道

傳回碼值

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

備註

sp_helpdistributor 用於所有類型的複寫。

如果在執行 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 none

下列結果集數據行會傳回給散發者端發行集之發行集存取清單中的使用者:

  • 目錄

下列結果集數據行會傳回給所有使用者。

結果集數據行 輸出參數
distributor @distributor
distribution database @distribdb
rpc server name @rpcsrvname
publisher type @publisher_type