sp_helparticle (Transact-SQL)

  • [アーティクル]

適用対象: SQL ServerAzure SQL Managed Instance

アーティクルに関する情報を表示します。 このストアド プロシージャは、パブリッシャー側のパブリケーション データベースで実行されます。 Oracle パブリッシャーの場合、このストアド プロシージャは任意のデータベースのディストリビューターで実行されます。

Transact-SQL 構文表記規則

構文

  
sp_helparticle [ @publication = ] 'publication'   
    [ , [ @article = ] 'article' ]  
    [ , [ @returnfilter = ] returnfilter ]  
    [ , [ @publisher = ] 'publisher' ]  
    [ , [ @found = ] found OUTPUT ]

引数

[ @publication = ] 'publication' パブリケーションの名前を指定します。 publication は sysname で、既定値はありません。

[ @article = ] 'article' パブリケーション内のアーティクルの名前を指定します。 article は sysname で、既定値は %. アーティクルが指定されていない場合は、指定されたパブリケーションのすべてのアーティクルに関する情報が返されます。

[ @returnfilter = ] returnfilter フィルター句を返す必要があるかどうかを指定します。 returnfilter は ビットで、既定値は 1 で、フィルター句を返します。

[ @publisher = ] 'publisher' Microsoft SQL Server 以外の発行元を指定します。 publisher は sysname で、既定値は NULL です。

Note

SQL Server パブリッシャー によって発行されたアーティクルに関する情報を要求する場合は、パブリッシャーを指定しないでください。

[ @found = ] found OUTPUT 内部使用のみ。

結果セット

列名 データ型 説明
アーティクル ID int 記事の ID。
アーティクル名 sysname 記事の名前。
基本オブジェクト nvarchar(257) アーティクルまたはストアド プロシージャによって表される基になるテーブルの名前。
destination オブジェクト sysname 宛先 (サブスクリプション) テーブルの名前。
synchronization オブジェクト nvarchar(257) 発行されたアーティクルを定義するビューの名前。
type smallint アーティクルのタイプです。

1 = ログベース。

3 = 手動フィルターを使用したログベース。

5 = 手動ビューを使用したログベース。

7 = 手動フィルターと手動ビューを使用したログベース。

8 = ストアド プロシージャの実行。

24 = シリアル化可能なストアド プロシージャの実行。

32 = ストアド プロシージャ (スキーマのみ)。

64 = ビュー (スキーマのみ)。

96 = 集計関数 (スキーマのみ)。

128 = 関数 (スキーマのみ)。

257 = ログベースのインデックス付きビュー。

259 = 手動フィルターを使用したログベースのインデックス付きビュー。

261 = 手動ビューのログベースのインデックス付きビュー。

263 = 手動フィルターと手動ビューを含むログベースのインデックス付きビュー。

320 = インデックス付きビュー (スキーマのみ)。
status tinyint 1 つ以上の アーティクル プロパティの &(ビットごとの AND) の結果を指定できます。

0x00 = 情報提供のみを目的として識別されます。 サポートされていません。 将来の互換性は保証されません。

0x01 = アーティクルがアクティブです。

0x08 = insert ステートメントに列名を含めます。

0x16 = パラメーター化されたステートメントを使用します。

0x32 = パラメーター化されたステートメントを使用し、insert ステートメントに列名を含めます。
フィルター nvarchar(257) テーブルを水平方向にフィルター処理するために使用されるストアド プロシージャ。 このストアド プロシージャは、FOR REPLICATION 句を使用して作成されている必要があります。
説明 nvarchar (255) 記事の説明的なエントリ。
insert_command nvarchar (255) テーブルアーティクルを使用して挿入をレプリケートするときに使用されるレプリケーション コマンドの種類。 詳細については、「トランザクション アーティクルに変更を反映する方法の指定」を参照してください。
update_command nvarchar (255) テーブルアーティクルを使用して更新プログラムをレプリケートするときに使用されるレプリケーション コマンドの種類。 詳細については、「トランザクション アーティクルに変更を反映する方法の指定」を参照してください。
delete_command nvarchar (255) テーブル アーティクルの削除をレプリケートするときに使用されるレプリケーション コマンドの種類です。 詳細については、「トランザクション アーティクルに変更を反映する方法の指定」を参照してください。
作成スクリプト パス nvarchar (255) ターゲット テーブルの作成に使用するアーティクル スキーマ スクリプトのパスと名前。
垂直パーティション 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 に設定されている場合、または true に設定auto_identity_range場合、サブスクライバーの ID 範囲の範囲サイズ。
threshold bigint ディストリビューション エージェントが新しい ID 範囲を割り当てるタイミングを示すパーセンテージ値。
identityrangemanagementoption int アーティクルに対して処理される ID 範囲管理を示します。
fire_triggers_on_スナップショット bit 初期スナップショットが適用されたときにレプリケートされたユーザー トリガーが実行されるかどうかです。

1 = ユーザー トリガーが実行されます。

0 = ユーザー トリガーは実行されません。

リターン コードの値

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

解説

sp_helparticleは、スナップショット レプリケーションとトランザクション レプリケーションで使用されます。

アクセス許可

sysadmin 固定サーバー ロール、db_owner固定データベース ロール、または現在のパブリケーションのパブリケーション アクセス リストのメンバーのみが、sp_helparticle実行できます。

例

DECLARE @publication AS sysname;
SET @publication = N'AdvWorksProductTran';

USE [AdventureWorks2022]
EXEC sp_helparticle
  @publication = @publication;
GO

参照

アーティクルのプロパティの表示と変更
sp_addarticle (Transact-SQL)
sp_articlecolumn (Transact-SQL)
sp_changearticle (Transact-SQL)
sp_droparticle (Transact-SQL)
レプリケーション ストアド プロシージャ (Transact-SQL)