sp_helpsubscription (Transact-SQL)
特定のパブリケーション、アーティクル、サブスクライバ、またはサブスクリプションの集合に関連付けられたサブスクリプション情報を一覧表示します。このストアド プロシージャは、パブリッシャ側でパブリケーション データベースについて実行されます。
.gif "トピック リンク アイコン")
構文
sp_helpsubscription [ [ @publication = ] 'publication' ]
[ , [ @article = ] 'article' ]
[ , [ @subscriber = ] 'subscriber' ]
[ , [ @destination_db = ] 'destination_db' ]
[ , [ @found=] found OUTPUT ]
[ , [ @publisher = ] 'publisher' ]
引数
[ @publication = ] 'publication'
関連付けられているパブリケーションの名前を指定します。publication のデータ型は sysname で、既定値は % です。既定値は、このサーバーに関するすべてのサブスクリプション情報を返すことを意味します。[ @article= ] 'article'
アーティクルの名前を指定します。article のデータ型は sysname で、既定値は % です。既定値は、選択したパブリケーションとサブスクライバに関するすべてのサブスクリプション情報を返すことを意味します。all を指定した場合は、パブリケーションの完全なサブスクリプションに対して 1 つのエントリが返されます。[ @subscriber= ] 'subscriber'
サブスクリプション情報を取得するサブスクライバの名前を指定します。subscriber のデータ型は sysname で、既定値は % です。既定値は、選択したパブリケーションとアーティクルに関するすべてのサブスクリプション情報を返すことを意味します。[ @destination_db= ] 'destination_db'
対象となるデータベースの名前を指定します。destination_db のデータ型は sysname で、既定値は % です。[ @found= ] **'found'**OUTPUT
行を返すことを示すフラグです。found のデータ型は int です。これは OUTPUT パラメータの 1 つであり、既定値は 23456 です。1 は、パブリケーションが見つかったことを示します。
0 は、パブリケーションが見つからないことを示します。
[ @publisher= ] 'publisher'
パブリッシャの名前を指定します。publisher のデータ型は sysname で、既定値は現在のサーバーの名前です。.gif "注意")
注Oracle パブリッシャの場合を除き、publisher は指定しないでください。
結果セット
列名 |
データ型 |
説明 |
|---|---|---|
subscriber |
sysname |
サブスクライバの名前。 |
publication |
sysname |
パブリケーションの名前。 |
article |
sysname |
アーティクルの名前。 |
destination database |
sysname |
レプリケートされたデータの格納先のデータベースの名前。 |
subscription status |
tinyint |
サブスクリプションの状態。 0 = 非アクティブ 1 = サブスクライブ済み 2 = アクティブ |
synchronization type |
tinyint |
サブスクリプションの同期の種類。 1 = 自動同期 2 = なし |
subscription type |
int |
サブスクリプションの種類。 0 = プッシュ 1 = プル 2 = 匿名 |
full subscription |
bit |
サブスクリプションがパブリケーション内のすべてのアーティクルを対象としているかどうかを示します。 0 = いいえ 1 = はい |
subscription name |
nvarchar(255) |
サブスクリプションの名前。 |
update mode |
int |
0 = 読み取り専用 1 = 即時更新サブスクリプション |
distribution job id |
binary(16) |
ディストリビューション エージェントのジョブ ID。 |
loopback_detection |
bit |
ディストリビューション エージェントが、サブスクライバで発生したトランザクションをサブスクライバに戻すかどうかを示します。 0 = 戻す 1 = 戻さない 双方向トランザクション レプリケーションで使用されます。詳細については、「双方向トランザクション レプリケーション」を参照してください。 |
offload_enabled |
bit |
レプリケーション エージェントの負荷を軽減するためにサブスクライバでの実行が設定されているかどうかを示します。 0 の場合、エージェントはパブリッシャで動作します。 1 の場合、エージェントはサブスクライバで動作します。 |
offload_server |
sysname |
エージェントをリモートから起動するときに使用できるサーバーの名前。NULL の場合は、MSdistribution_agents テーブル内の現在の offload_server が使用されます。 |
dts_package_name |
sysname |
データ変換サービス (DTS) パッケージの名前。 |
dts_package_location |
int |
DTS パッケージがサブスクリプションに割り当てられている場合の、DTS パッケージの場所。パッケージがある場合、値 0 は、パッケージの場所がディストリビュータであることを示します。値 1 は、サブスクライバであることを示します。 |
subscriber_security_mode |
smallint |
サブスクライバでのセキュリティ モード。1 は Windows 認証を表し、0 は SQL Server 認証を表します。 |
subscriber_login |
sysname |
サブスクライバでのログイン名。 |
subscriber_password |
|
実際のサブスクライバ パスワードは返されません。結果は "******" 文字列によりマスクされます。 |
job_login |
sysname |
ディストリビューション エージェントが実行される Windows アカウントの名前。 |
job_password |
|
実際のジョブ パスワードは返されません。結果は "******" 文字列によりマスクされます。 |
distrib_agent_name |
nvarchar(100) |
サブスクリプションと同期するエージェント ジョブの名前。 |
subscriber_type |
tinyint |
サブスクライバの種類。次のいずれかになります。
値説明
0SQL Server サブスクライバ
1ODBC データ ソース サーバー
2Microsoft JET データベース (推奨されません)
3OLE DB プロバイダ
|
subscriber_provider |
sysname |
SQL Server 以外のデータ ソース用の OLE DB プロバイダを登録するときに使用される、一意なプログラム識別子 (PROGID)。 |
subscriber_datasource |
nvarchar(4000) |
OLE DB プロバイダで認識されるデータ ソースの名前。 |
subscriber_providerstring |
nvarchar(4000) |
データ ソースを識別する、OLE DB プロバイダ固有の接続文字列。 |
subscriber_location |
nvarchar(4000) |
OLE DB プロバイダで認識されるデータベースの場所。 |
subscriber_catalog |
sysname |
OLE DB プロバイダに接続するときに使用されるカタログ。 |
リターン コード値
0 (成功) または 1 (失敗)
説明
sp_helpsubscription は、スナップショットおよびトランザクション レプリケーションで使用します。
権限
実行権限は、既定では public ロールに与えられています。ユーザーに返されるのは、ユーザーが自分で作成したサブスクリプションの情報だけです。パブリッシャの sysadmin 固定サーバー ロールのメンバ、またはパブリケーション データベースの db_owner 固定データベース ロールのメンバには、すべてのサブスクリプションに関する情報が返されます。