sp_helpdistributor (Transact-SQL)

ディストリビューター、ディストリビューション データベース、作業ディレクトリ、および Microsoft 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_distretentionOUTPUT
  ディストリビューションの最小保有期間を時間単位で示します。 min_distretention のデータ型は int で、既定値は -1 です。

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

• [ @history_retention=] history_retentionOUTPUT
  履歴の保有期間を時間単位で示します。 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

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

関連項目

参照

sp_adddistpublisher (Transact-SQL)

sp_dropdistpublisher (Transact-SQL)

概念

ディストリビューターとパブリッシャーのプロパティの表示および変更