sp_helpdistributor (Transact-SQL)

適用対象:SQL Server (サポートされているすべてのバージョン) Azure SQL Managed Instance

ディストリビューター、ディストリビューション データベース、作業ディレクトリ、および Microsoft SQL Server エージェント ユーザー アカウントに関する情報を一覧表示します。 このストアド プロシージャは、パブリッシャー側のパブリケーション データベースまたは任意のデータベースで実行されます。

Topic link iconTransact-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 ディストリビューターの名前です。 ディストリビューターは sysname で、既定値 %は結果セットを返す唯一の値です。

[ @distribdb = ] 'distribdb' OUTPUT ディストリビューション データベースの名前です。 distribdbsysname で、既定値 %は結果セットを返す唯一の値です。

[ @directory = ] 'directory' OUTPUT 作業ディレクトリです。 directorynvarchar(255) で、既定値 %は結果セットを返す唯一の値です。

[ @account = ] 'account' OUTPUT Microsoft Windows ユーザー アカウントです。 accountnvarchar(255) で、既定値 %は結果セットを返す唯一の値です。

[ @min_distretention = ] _min_distretentionOUTPUT 配布の最小保有期間 (時間単位) です。 min_distretentionint で、既定値は -1 です

[ @max_distretention = ] _max_distretentionOUTPUT ディストリビューションの最大保有期間を時間単位で指定します。 max_distretentionint で、既定値は -1 です

[ @history_retention = ] _history_retentionOUTPUT 履歴の保持期間を時間単位で指定します。 history_retentionint で、既定値は -1 です

[ @history_cleanupagent = ] 'history_cleanupagent' OUTPUT 履歴クリーンアップ エージェントの名前です。 history_cleanupagentnvarchar(100) で、既定値 %は結果セットを返す唯一の値です。

[ @distrib_cleanupagent = ] 'distrib_cleanupagent' OUTPUT ディストリビューション クリーンアップ エージェントの名前です。 distrib_cleanupagentnvarchar(100) で、既定値 %は結果セットを返す唯一の値です。

[ @publisher = ] 'publisher' パブリッシャーの名前です。 publishersysname で、既定値は NULL です。

[ @local = ] 'local'SQL Serverがローカル サーバーの値を取得する必要があるかどうかを指定します。 localnvarchar(5)で、既定値は NULL です。

[ @rpcsrvname = ] 'rpcsrvname' OUTPUT リモート プロシージャ コールを発行するサーバーの名前です。 rpcsrvnamesysname で、既定値 %は結果セットを返す唯一の値です。

[ @publisher_type = ] 'publisher_type' OUTPUT パブリッシャーの発行元の種類です。 publisher_typesysname で、既定値 %は結果セットを返す唯一の値です。

結果セット

列名 データ型 説明
ディストリビューター sysname ディストリビューターの名前。
ディストリビューション データベース sysname ディストリビューション データベースの名前。
directory nvarchar (255) 作業ディレクトリの名前。
アカウント nvarchar (255) Windows ユーザー アカウントの名前です。
min distrib retention int 最小配布リテンション期間。
最大 distrib リテンション期間 int 最大配布リテンション期間。
history retention int 履歴の保持期間。
history cleanup agent nvarchar(100) 履歴クリーンアップ エージェントの名前。
ディストリビューション クリーンアップ エージェント (distribution cleanup agent) nvarchar(100) ディストリビューション クリーンアップ エージェントの名前。
rpc server name sysname リモート またはローカル ディストリビューターの名前。
rpc ログイン名 sysname リモート ディストリビューターに対するリモート プロシージャ呼び出しで使用するログインです。
パブリッシャーの種類 sysname パブリッシャーの種類。は、次のいずれかになります。

MSSQLSERVER

Oracle

ORACLE GATEWAY

リターン コードの値

0 (成功) または 1 (失敗)

注釈

sp_helpdistributor は、すべての種類のレプリケーションで使用されます。

sp_helpdistributorの実行時に 1 つ以上の出力パラメーターを指定すると、NULL に設定されたすべての出力パラメーターに終了時に値が割り当てられ、結果セットは返されません。 出力パラメーターが指定されていない場合は、結果セットが返されます。

アクセス許可

次の結果セットの列または出力パラメーターは、パブリッシャーの sysadmin 固定サーバー ロールのメンバーと、パブリケーション データベース の固定 データベース ロールdb_ownerに返されます。

結果セットの列 出力パラメーター
account @account
min distrib retention @min_distretention
最大 distrib リテンション期間 @max_distretention
history retention @history_retention
history cleanup agent @history_cleanupagent
ディストリビューション クリーンアップ エージェント (distribution cleanup agent) @distrib_cleanupagent
rpc ログイン名 なし

次の結果セット列は、ディストリビューターのパブリケーション用のパブリケーション アクセス リストのユーザーに返されます。

  • directory

次の結果セット列は、すべてのユーザーに返されます。

結果セットの列 出力パラメーター
ディストリビューター (distributor) @distributor
ディストリビューション データベース (distribution database) @distribdb
rpc server name @rpcsrvname
publisher type @publisher_type

参照

ディストリビューターとパブリッシャーのプロパティの表示および変更
sp_adddistpublisher (Transact-SQL)
sp_dropdistpublisher (Transact-SQL)