sp_helpdistributor (Transact-SQL)

適用対象: SQL Server Azure 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_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 で、既定値は % で、結果セットを返す唯一の値です。

結果セット

リターン コードの値

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

解説

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

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

アクセス許可

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

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

• directory

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

関連するコンテンツ

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