sp_helparticle (Transact-SQL)

  • [アーティクル]

適用対象: SQL Server Azure SQL Managed Instance

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

Transact-SQL 構文表記規則

構文

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

引数

[ @publication = ] N'publication'

出版物の名前。 @publication は sysname で、既定値はありません。

[ @article = ] N'article'

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

[ @returnfilter = ] returnfilter

フィルター句を返すかどうかを指定します。 @returnfilter は bit で、既定値は 1 で、フィルター句が返されます。

[ @publisher = ] N'publisher'

SQL Server 以外のパブリッシャーを指定します。 @publisher は sysname で、既定値は NULL です。

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 = ビュー (スキーマのみ)。
96 = 集計関数 (スキーマのみ)。
128 = 関数 (スキーマのみ)。
257 = ログベースのインデックス付きビュー。
259 = 手動フィルターを使用したログ ベースのインデックス付きビュー。
261 = 手動ビューを含むログベースのインデックス付きビュー。
263 = 手動フィルターと手動ビューを含むログベースのインデックス付きビュー。
320 = インデックス付きビュー (スキーマのみ)。
status tinyint 1 つ以上のアーティクル プロパティの結果 & (ビットごとの AND) にすることができます。

0x00 = 情報提供のみを目的として識別されます。 サポートされていません。 将来の互換性は保証されません。
0x01 = アーティクルがアクティブです。
0x08 = insert ステートメントに列名を含めます。
0x16 = パラメーター化されたステートメントを使用します。
0x32 = パラメーター化されたステートメントを使用し、insert ステートメントに列名を含めます。
filter nvarchar(257) テーブルを水平方向にフィルター処理するために使用されるストアド プロシージャ。 このストアド プロシージャは、 FOR REPLICATION 句を使用して作成する必要があります。
description nvarchar (255) 記事の説明的なエントリ。
insert_command nvarchar (255) テーブルアーティクルを使用して挿入をレプリケートするときに使用されるレプリケーション コマンドの種類。 1
update_command nvarchar (255) テーブルアーティクルを使用して更新プログラムをレプリケートするときに使用されるレプリケーション コマンドの種類。 1
delete_command nvarchar (255) テーブル アーティクルの削除をレプリケートするときに使用されるレプリケーション コマンドの種類です。 1
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を参照してください。
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 アーティクルがautoに設定されているか、trueに設定auto_identity_range場合、パブリッシャーの ID 範囲の範囲サイズidentityrangemanagementoption。
identity_range bigint アーティクルがautoに設定されているか、trueに設定されている場合identityrangemanagementoptionサブスクライバーの ID 範囲の範囲サイズauto_identity_range。
threshold bigint ディストリビューション エージェントが新しい ID 範囲を割り当てるタイミングを示すパーセンテージ値。
identityrangemanagementoption int アーティクルに対して処理される ID 範囲管理を示します。
fire_triggers_on_snapshot bit 初期スナップショットが適用されたときにレプリケートされたユーザー トリガーが実行されるかどうかです。

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

1 詳細については、「 Transactional Articles - Specify How changes are Propagated(変更の伝達方法の指定)」を参照してください。

リターン コードの値

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

関連するコンテンツ