cdc.fn_cdc_get_all_changes_<capture_instance> (Transact-SQL)

[アーティクル]
07/03/2024

適用対象: SQL Server

指定したログシーケンス番号 (LSN) 範囲内のソーステーブルに適用された変更ごとに 1 行を返します。該当する期間中、1 つのソース行に複数の変更が加えられた場合、返される結果セットには、それぞれの変更が格納されます。変更データを返すだけでなく、4 つのメタデータ列によって、変更を別のデータソースに適用するために必要な情報が提供されます。行フィルターオプションは、メタデータ列の内容と、結果セットで返される行を制御します。 "all" 行フィルターオプションが指定されている場合、各変更には変更を識別するための行が 1 つだけ含まれます。 'all update old' オプションを指定すると、更新操作は 2 つの行として表されます。1 つは更新前にキャプチャされた列の値を含み、もう 1 つは更新後にキャプチャされた列の値を含みます。

この列挙関数は、ソーステーブルで変更データキャプチャが有効になっている時点で作成されます。関数名は派生し、 cdc.fn_cdc_get_all_changes_<capture_instance> 形式を使用します。ここで capture_instance は、ソーステーブルで変更データキャプチャが有効になっている場合にキャプチャインスタンスに指定された値です。

Transact-SQL 構文表記規則

構文

  
cdc.fn_cdc_get_all_changes_capture_instance ( from_lsn , to_lsn , '<row_filter_option>' )  
  
<row_filter_option> ::=  
{ all  
 | all update old  
}

引数

from_lsn

結果セットに含める LSN 範囲の下端を表す LSN 値を指定します。 from_lsn は binary(10)です。

cdc 内の行のみ。[capture_instance]_CT__$start_lsnの値がfrom_lsn以上の値を持つ変更テーブルが結果セットに含まれます。

to_lsn

結果セットに含める LSN 範囲の上端を表す LSN 値を指定します。 to_lsn は binary(10)です。

cdc 内の行のみ。[capture_instance]_CT変更テーブルの値が __$start_lsn from_lsn以上、to_lsn以下の値が結果セットに含まれます。

<row_filter_option> ::= { all | all update old }

メタデータ列の内容と、結果セットで返される行を管理するオプション。

次のいずれかのオプションを指定できます。

すべて
指定した LSN 範囲内のすべての変更を返します。更新操作で生じた変更の場合、更新適用後の新しい値を格納した行だけが返されます。

すべての更新プログラムが古い
指定した LSN 範囲内のすべての変更を返します。更新操作による変更の場合、このオプションは、更新前の列値を含む行と、更新後の列値を含む行の両方を返します。

返されるテーブル

列名	データ型	説明
__$start_lsn	binary(10)	変更のコミット順序を保持する変更に関連付けられている LSN をコミットします。同じトランザクションでコミットされた変更は、同じコミット LSN 値を共有します。
__$seqval	binary(10)	トランザクション内の行に対する変更を並べ替えるために使用されるシーケンス値。
__$operation	int	変更データの行をターゲットデータソースに適用するために必要なデータ操作言語 (DML) 操作を識別します。以下のいずれかを指定できます。 1 = 削除 2 = 挿入 3 = 更新 (キャプチャされる列値は更新操作前の値)。この値が該当するのは、行フィルターオプションに 'all update old' を指定した場合だけです。 4 = 更新 (キャプチャされた列の値は更新操作後の値)
__$update_mask	varbinary (128)	キャプチャインスタンスに対して指定された各キャプチャ対象列に対応するビットを持ったビットマスク。この値には、 __$operation = 1 または 2 の場合、定義されているすべてのビットが 1 に設定されます。 __$operation = 3 または 4 の場合、変更された列に対応するビットのみが 1 に設定されます。
<キャプチャ対象のソーステーブルの列>	多様	関数によって返される残りの列は、キャプチャインスタンスの作成時に識別されるキャプチャ列です。キャプチャ対象列リストで列が指定されなかった場合、ソーステーブルのすべての列が返されます。

アクセス許可

sysadmin固定サーバーロールまたは固定データベースロールdb_ownerメンバーシップが必要です。他のすべてのユーザーには、ソーステーブル内のキャプチャされたすべての列に対する SELECT アクセス許可と、キャプチャインスタンスのゲーティングロールが定義されている場合は、そのデータベースロールのメンバーシップが必要です。呼び出し元にソースデータを表示するアクセス許可がない場合、関数はエラー 229 を返します The SELECT permission was denied on the object 'fn_cdc_get_all_changes_...', database '\<DatabaseName>', schema 'cdc'.

解説

データ型 image、 text、および ntext の列には、 __$operation = 1 または __$operation = 3 の場合、常に NULL 値が割り当てられます。データ型 varbinary(max)、 varchar(max)、または nvarchar(max) の列には、更新中に列が変更されない限り、 __$operation = 3 の場合は NULL 値が割り当てられます。 __$operation = 1 の場合、これらの列には削除時に値が割り当てられます。キャプチャインスタンスに含まれる計算列の値は、常に NULL になります。

指定された LSN 範囲が、 cdc.fn_cdc_get_all_changes_<capture_instance> または cdc.fn_cdc_get_net_changes_<capture_instance>を呼び出すときに適切でない場合は、エラー 313 が予期されます。 lsn_value パラメーターが最も低い LSN または最大 LSN の時間を超えている場合、これらの関数の実行はエラー 313: Msg 313, Level 16, State 3, Line 1 An insufficient number of arguments were supplied for the procedure or functionで返されます。このエラーは、開発者が処理する必要があります。

例

変更データキャプチャクエリ関数の使用方法を示す SQL Server Management Studio テンプレートがいくつか用意されています。これらのテンプレートは、Management Studio の View メニューで使用できます。詳細については、「 Template Explorer」を参照してください。

この例は、Enumerate All Changes for Valid Range Template を示しています。この例では、関数 cdc.fn_cdc_get_all_changes_HR_Department を使用して、AdventureWorks2022 データベース内の HumanResources.Department ソーステーブルに対して定義されているキャプチャインスタンス HR_Department で現在使用できる変更をすべてレポートします。

-- ========  
-- Enumerate All Changes for Valid Range Template  
-- ========  
USE AdventureWorks2022;  
GO  
  
DECLARE @from_lsn binary(10), @to_lsn binary(10);  
SET @from_lsn = sys.fn_cdc_get_min_lsn('HR_Department');  
SET @to_lsn   = sys.fn_cdc_get_max_lsn();  
SELECT * FROM cdc.fn_cdc_get_all_changes_HR_Department  
  (@from_lsn, @to_lsn, N'all');  
GO

次の方法で共有