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 をそれぞれ返します。

結果セット

列名 データ型 説明

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

パブリッシャの種類です。次のいずれかになります。

MSSQLSERVER

ORACLE

ORACLE GATEWAY

解説

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_cleanupagent

distribution cleanup agent

@distrib_cleanupagent

rpc login name

なし

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

  • directory

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

結果セット列 出力パラメータ

distributor

@distributor

distribution database

@distribdb

rpc server name

@rpcsrvname

publisher type

@publisher_type

参照

関連項目

sp_adddistpublisher (Transact-SQL)
sp_dropdistpublisher (Transact-SQL)

その他の技術情報

パブリッシャとディストリビュータのプロパティを表示および変更する方法 (レプリケーション Transact-SQL プログラミング)

ヘルプおよび情報

SQL Server 2005 の参考資料の入手