sys.sp_helpdistributor(Transact-SQL)

適用対象:SQL ServerAzure SQL Managed Instance

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

Transact-SQL 構文表記規則

構文

sys.sp_helpdistributor
    [ [ @distributor = ] N'distributor' OUTPUT ]
    [ , [ @distribdb = ] N'distribdb' OUTPUT ]
    [ , [ @directory = ] N'directory' OUTPUT ]
    [ , [ @account = ] N'account' OUTPUT ]
    [ , [ @min_distretention = ] min_distretention OUTPUT ]
    [ , [ @max_distretention = ] max_distretention OUTPUT ]
    [ , [ @history_retention = ] history_retention OUTPUT ]
    [ , [ @history_cleanupagent = ] N'history_cleanupagent' OUTPUT ]
    [ , [ @distrib_cleanupagent = ] N'distrib_cleanupagent' OUTPUT ]
    [ , [ @publisher = ] N'publisher' ]
    [ , [ @local = ] N'local' ]
    [ , [ @rpcsrvname = ] N'rpcsrvname' OUTPUT ]
    [ , [ @publisher_type = ] N'publisher_type' OUTPUT ]
    [ , [ @deletebatchsize_xact = ] deletebatchsize_xact OUTPUT ]
    [ , [ @deletebatchsize_cmd = ] deletebatchsize_cmd OUTPUT ]
    [ , [ @dist_listener = ] N'dist_listener' OUTPUT ]
[ ; ]

引数

[ @distributor = ] N'ディストリビューター出力

ディストリビューターの名前。 @distributor は sysname で、既定値は % で、結果セットを返す唯一の値です。

[ @distribdb = ] N'distribdb' 出力

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

[ @directory = ] N'directory' OUTPUT

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

[ @account = ] n'account' アウトプット

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

[ @min_distretention = ] min_distretention 出力

ディストリビューションの最小保有期間 (時間単位)。 @min_distretention は int で、既定値は -1 です。

[ @max_distretention = ] max_distretention 出力

ディストリビューションの最大保有期間 (時間単位)。 @max_distretention は int で、既定値は -1 です。

[ @history_retention = ] history_retention 出力

履歴の保持期間 (時間単位)。 @history_retention は int で、既定値は -1 です。

[ @history_cleanupagent = ] N'history_cleanupagent' 出力

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

[ @distrib_cleanupagent = ] N'distrib_cleanupagent' 出力

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

[ @publisher = ] N'publisher'

パブリッシャーの名前。 @publisher は sysname で、既定値は NULL です。

[ @local = ] 地元出身

SQL Server がローカル サーバーの値を取得する必要があるかどうか。 @local は nvarchar(5) で、既定値は NULL です。

[ @rpcsrvname = ] N'rpcsrvname' 出力

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

[ @publisher_type = ] N'publisher_type' アウトプット

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

[ @deletebatchsize_xact = ] deletebatchsize_xact 出力

単に情報を示すためだけに特定されます。 サポートされていません。 将来の互換性は保証されません。

[ @deletebatchsize_cmd = ] deletebatchsize_cmd 出力

単に情報を示すためだけに特定されます。 サポートされていません。 将来の互換性は保証されません。

[ @dist_listener = ] N'dist_listener' 出力

単に情報を示すためだけに特定されます。 サポートされていません。 将来の互換性は保証されません。

結果セット

リターン コードの値

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

解説

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

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

アクセス許可

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

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

• ディレクトリ

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

関連するコンテンツ

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