sp_helparticle (Transact-SQL)
アーティクルに関する情報を表示します。このストアド プロシージャは、パブリッシャ側でパブリケーション データベースについて実行されます。Oracle パブリッシャの場合、このストアド プロシージャは、ディストリビュータ側で任意のデータベースについて実行されます。
.gif "トピック リンク アイコン")
構文
sp_helparticle [ @publication = ] 'publication'
[ , [ @article = ] 'article' ]
[ , [ @returnfilter = ] returnfilter ]
[ , [ @publisher = ] 'publisher' ]
[ , [ @found = ] found OUTPUT ]
引数
[ @publication =] 'publication'
パブリケーションの名前を指定します。publication のデータ型は sysname で、既定値はありません。[ @article=] 'article'
パブリケーション内のアーティクルの名前を指定します。article のデータ型は sysname で、既定値は % です。article が指定されていない場合は、指定されたパブリケーションのすべてのアーティクルに関する情報を返します。[ @returnfilter=] returnfilter
フィルタ句を返すかどうかを指定します。returnfilter のデータ型は bit で、既定値は 1 です。1 は、フィルタ句を返すことを示します。[ @publisher= ] 'publisher'
MicrosoftSQL Server 以外のパブリッシャを指定します。publisher のデータ型は sysname で、既定値は NULL です。.gif "注意")
注意SQL Server パブリッシャによってパブリッシュされたアーティクルの情報を要求するときには、publisher を指定しないでください。
[ @found= ] found OUTPUT
内部使用のみです。
結果セット
列名 |
データ型 |
説明 |
|---|---|---|
article id |
int |
アーティクルの ID です。 |
article name |
sysname |
アーティクルの名前です。 |
base object |
nvarchar(257) |
アーティクルまたはストアド プロシージャが表す基になるテーブルの名前です。 |
destination object |
sysname |
パブリッシュ先の (サブスクリプション) テーブル名です。 |
synchronization object |
nvarchar(257) |
パブリッシュされるアーティクルを定義するビューの名前です。 |
type |
smallint |
アーティクルのタイプです。 1 = ログベースのアーティクル 3 = 手動フィルタ付きログベースのアーティクル 5 = 手動ビュー付きログベースのアーティクル 7 = 手動フィルタおよび手動ビュー付きログベースのアーティクル 8 = ストアド プロシージャの実行 24 = シリアル化可能なストアド プロシージャの実行 32 = ストアド プロシージャ (スキーマのみ) 64 = ビュー (スキーマのみ) 128 = 関数 (スキーマのみ) |
status |
tinyint |
これらの 1 つ以上のアーティクル プロパティの & (ビット演算 AND) の結果になります。 0x00 = 単に情報を示すためだけに特定されます。 サポートされていません。 将来の互換性は保証されません。 0x01 = アーティクルはアクティブ 0x08 = INSERT ステートメントに列名を含める 0x16 = パラメータ化されたステートメントを使用する 0x32 = パラメータ化されたステートメントを使用し、INSERT ステートメントに列名を含める |
filter |
nvarchar(257) |
テーブルを行方向にフィルタ選択するために使用するストアド プロシージャです。このストアド プロシージャは FOR REPLICATION 句を使用して作成されている必要があります。 |
description |
nvarchar(255) |
アーティクルを説明するエントリです。 |
insert_command |
nvarchar(255) |
テーブル アーティクルの挿入をレプリケートするときに使用されるレプリケーション コマンドの種類です。詳細については、「トランザクション アーティクルに変更を反映する方法の指定」を参照してください。 |
update_command |
nvarchar(255) |
テーブル アーティクルの更新をレプリケートするときに使用されるレプリケーション コマンドの種類です。詳細については、「トランザクション アーティクルに変更を反映する方法の指定」を参照してください。 |
delete_command |
nvarchar(255) |
テーブル アーティクルの削除をレプリケートするときに使用されるレプリケーション コマンドの種類です。詳細については、「トランザクション アーティクルに変更を反映する方法の指定」を参照してください。 |
creation script path |
nvarchar(255) |
ターゲット テーブルを作成するのに使用されるアーティクル スキーマ スクリプトのパスと名前です。 |
vertical partition |
bit |
列方向のパーティション分割がアーティクルに対して有効になっているかどうかを示します。1 の値は、列方向のパーティション分割が有効であることを意味します。 |
pre_creation_cmd |
tinyint |
DROP TABLE、DELETE TABLE、または TRUNCATE TABLE の事前作成コマンドです。 |
filter_clause |
ntext |
行方向のフィルタ選択を指定する WHERE 句です。 |
schema_option |
binary(8) |
指定されたアーティクルに対するスキーマ生成オプションのビットマップです。schema_option 値の一覧については、「sp_addarticle (Transact-SQL)」を参照してください。 |
dest_owner |
sysname |
対象オブジェクトの所有者名です。 |
source_owner |
sysname |
ソース オブジェクトの所有者です。 |
unqua_source_object |
sysname |
所有者名の部分を除いたソース オブジェクトの名前です。 |
sync_object_owner |
sysname |
パブリッシュされるアーティクルを定義するビューの所有者です。 |
unqualified_sync_object |
sysname |
所有者名の部分を除いた、パブリッシュされるアーティクルを定義するビューの名前です。 |
filter_owner |
sysname |
フィルタの所有者です。 |
unqua_filter |
sysname |
所有者名の部分を除いたフィルタ名です。 |
auto_identity_range |
int |
パブリケーションの作成時に、ID 範囲の自動処理がパブリケーションで有効に設定されたかどうかを示すフラグです。1 は、ID 範囲の自動処理が有効であることを表します。0 は、無効であることを表します。 |
publisher_identity_range |
int |
アーティクルの identityrangemanagementoption が auto、または auto_identity_range が true に設定されている場合のパブリッシャの ID 範囲の大きさです。 |
identity_range |
bigint |
アーティクルの identityrangemanagementoption が auto、または auto_identity_range が true に設定されている場合のサブスクライバの ID 範囲の大きさです。 |
threshold |
bigint |
ディストリビューション エージェントがどの時点で新しい ID 範囲を割り当てるかを制御するパーセンテージの値です。 |
identityrangemanagementoption |
int |
アーティクルに対して処理される ID 範囲管理を示します。 |
fire_triggers_on_snapshot |
bit |
初期スナップショットが適用されたときに、レプリケートされたユーザー トリガが実行されるかどうかを示します。 1 = ユーザー トリガは実行される 0 = ユーザー トリガは実行されない |
リターン コードの値
成功した場合は 0 を、失敗した場合は 1 をそれぞれ返します。
説明
sp_helparticle は、スナップショット レプリケーションおよびトランザクション レプリケーションで使用します。
権限
sp_helparticle を実行できるのは、固定サーバー ロール sysadmin、固定データベース ロール db_owner、または現在のパブリケーションのパブリケーション アクセス リストのメンバだけです。
使用例
DECLARE @publication AS sysname;
SET @publication = N'AdvWorksProductTran';
USE [AdventureWorks]
EXEC sp_helparticle
@publication = @publication;
GO