sp_helpdistributor (Transact-SQL)

  • [アーティクル]

適用対象: SQL ServerAzure SQL Managed Instance

ディストリビューター、ディストリビューション データベース、作業ディレクトリ、および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_クリーンupagent' OUTPUT

履歴 クリーンup エージェントの名前。 @history_クリーンupagent は nvarchar(100) で、既定値%は結果セットを返す唯一の値です。

[ @distrib_cleanupagent = ] 'distrib_クリーンupagent' OUTPUT

ディストリビューション クリーンアップ エージェントの名前。 @distrib_クリーンupagent は 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 パブリッシャーの種類。は、次のいずれかになります。

- MSSQL Standard Edition RVER
-Oracle
- ORACLE GATEWAY

リターン コードの値

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

解説

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

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

アクセス許可

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

結果セット列 出力パラメーター
account @account
min distrib retention @min_distretention
max distrib retention @max_distretention
history retention @history_retention
history cleanup agent @history_クリーンupagent
distribution cleanup agent @distrib_クリーンupagent
rpc login name なし

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

  • directory

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

結果セット列 出力パラメーター
distributor @distributor
distribution database @distribdb
rpc server name @rpcsrvname
publisher type @publisher_type

関連するコンテンツ