sys.sp_cdc_help_change_data_capture (TRANSACT-SQL)sys.sp_cdc_help_change_data_capture (Transact-SQL)

適用対象: ○SQL Server XAzure SQL Database XAzure SQL Data Warehouse XParallel Data WarehouseAPPLIES TO: yesSQL Server noAzure SQL Database noAzure SQL Data Warehouse noParallel Data Warehouse

変更データ キャプチャの構成を有効になっている各テーブルを返しますでは、現在のデータベース内のデータのキャプチャを変更します。Returns the change data capture configuration for each table enabled for change data capture in the current database. ソース テーブルごとに、最大で 2 つの行が返される各キャプチャ インスタンスの 1 つの行。Up to two rows can be returned for each source table, one row for each capture instance. 変更データ キャプチャは、 MicrosoftMicrosoftSQL ServerSQL Serverのすべてのエディッションで使用できるわけではありません。Change data capture is not available in every edition of MicrosoftMicrosoftSQL ServerSQL Server. SQL ServerSQL Serverの各エディションでサポートされる機能の一覧については、「 SQL Server 2016 の各エディションがサポートする機能」を参照してください。For a list of features that are supported by the editions of SQL ServerSQL Server, see Features Supported by the Editions of SQL Server 2016.

トピック リンク アイコン Transact-SQL 構文表記規則Topic link icon Transact-SQL Syntax Conventions

構文Syntax

  
sys.sp_cdc_help_change_data_capture   
  [ [ @source_schema = ] 'source_schema' ]  
  [, [ @source_name = ] 'source_name' ]  

引数Arguments

[ @source_schema =] 'source_schema'[ @source_schema = ] 'source_schema'
ソース テーブルが所属するスキーマの名前です。Is the name of the schema in which the source table belongs. source_schemasysname、既定値は NULL です。source_schema is sysname, with a default of NULL. ときにsource_schemaが指定されているsource_nameも指定する必要があります。When source_schema is specified, source_name must also be specified.

NULL 以外の場合source_schema現在のデータベースに存在する必要があります。If non-NULL, source_schema must exist in the current database.

場合source_schema NULL 以外の場合は、 source_name NULL である必要があります。If source_schema is non-NULL, source_name must also be non-NULL.

[ @source_name =] 'source_name'[ @source_name = ] 'source_name'
ソース テーブルの名前です。Is the name of the source table. source_namesysname、既定値は NULL です。source_name is sysname, with a default of NULL. ときにsource_nameが指定されているsource_schemaも指定する必要があります。When source_name is specified, source_schema must also be specified.

NULL 以外の場合source_name現在のデータベースに存在する必要があります。If non-NULL, source_name must exist in the current database.

場合source_name NULL 以外の場合は、 source_schema NULL である必要があります。If source_name is non-NULL, source_schema must also be non-NULL.

リターン コードの値Return Code Values

0 (成功) または 1 (失敗)0 (success) or 1 (failure)

結果セットResult Sets

列名Column name データ型Data type 説明Description
source_schemasource_schema sysnamesysname ソース テーブルのスキーマ名です。Name of the source table schema.
ソース テーブルsource_table sysnamesysname ソース テーブルの名前。Name of the source table.
capture_instancecapture_instance sysnamesysname キャプチャ インスタンスの名前です。Name of the capture instance.
object_idobject_id intint ソース テーブルに関連付けられている変更テーブルの ID。ID of the change table associated with the source table.
source_object_idsource_object_id intint ソース テーブルの ID。ID of the source table.
start_lsnstart_lsn binary(10)binary(10) 変更テーブルをクエリする際の下端を表すログ シーケンス番号 (LSN) です。Log sequence number (LSN) representing the low endpoint for querying the change table.

NULL、低の = エンドポイントが確立されていません。NULL = the low endpoint has not been established.
end_lsnend_lsn binary(10)binary(10) 変更テーブルのクエリの上端を表す LSN です。LSN representing the high endpoint for querying the change table. SQL Server 2012 (11.x)SQL Server 2012 (11.x) では、この列は常に NULL です。In SQL Server 2012 (11.x)SQL Server 2012 (11.x), this column is always NULL.
supports_net_changessupports_net_changes bitbit 差分変更のサポートが有効になっているとします。Net change support is enabled.
has_drop_pendinghas_drop_pending bitbit SQL Server 2012 (11.x)SQL Server 2012 (11.x) では使用されません。Not used in SQL Server 2012 (11.x)SQL Server 2012 (11.x).
role_namerole_name sysnamesysname 変更データへのアクセスを制御するデータベース ロールの名前です。Name of the database role used to control access to the change data.

NULL = ロールは使用されません。NULL = a role is not used.
index_nameindex_name sysnamesysname ソース テーブル内の行を一意に識別するために使用するインデックスの名前。Name of the index used to uniquely identify rows in the source table.
filegroup_namefilegroup_name sysnamesysname 変更テーブルが存在するファイル グループの名前。Name of the filegroup in which the change table resides.

NULL = 変更テーブルは、データベースの既定のファイル グループにします。NULL = change table is in the default filegroup of the database.
create_datecreate_date datetimedatetime キャプチャ インスタンスの有効化された日付。Date that the capture instance was enabled.
index_column_listindex_column_list nvarchar(max)nvarchar(max) ソース テーブル内の行を一意に識別するためのインデックス列の一覧です。List of index columns used to uniquely identify rows in the source table.
captured_column_listcaptured_column_list nvarchar(max)nvarchar(max) キャプチャ対象のソース列のリスト。List of captured source columns.

コメントRemarks

ときに両方source_schemasource_name既定で null の場合、または null の場合を明示的に設定されてこのストアド プロシージャは、呼び出し元が キャプチャ インスタンス、データベースのすべての情報を返しますアクセスします。When both source_schema and source_name default to NULL, or are explicitly set the NULL, this stored procedure returns information for all of the database capture instances that the caller has SELECT access to. ときにsource_schemasource_nameは NULL 以外で、特定の名前付きの有効なテーブルに関する情報のみが返されます。When source_schema and source_name are non-NULL, only information on the specific named enabled table is returned.

アクセス許可Permissions

ときにsource_schemasource_nameが NULL の場合、呼び出し元の承認が有効なテーブルが結果セットに含まれるを決定します。When source_schema and source_name are NULL, the caller's authorization determines which enabled tables are included in the result set. 呼び出し元によっては、すべてのキャプチャ インスタンスとも含まれるテーブルについては、定義されたゲーティング ロールのメンバーシップのキャプチャ対象列に対する SELECT 権限が必要です。Callers must have SELECT permission on all of the captured columns of the capture instance and also membership in any defined gating roles for the table information to be included. データベース ロール db_owner のメンバーは、すべて定義されているキャプチャ インスタンスに関する情報を表示できます。Members of the db_owner database role can view information about all defined capture instances. 特定の有効なテーブルの情報を要求すると、名前付きのテーブルの同じ SELECT およびメンバーシップ基準が適用されます。When information for a specific enabled table is requested, the same SELECT and membership criteria are applied for the named table.

使用例Examples

A.A. 指定したテーブルについて変更データ キャプチャの構成情報を取得するReturning change data capture configuration information for a specified table

次の例は、HumanResources.Employee テーブルを対象に変更データ キャプチャの構成を取得します。The following example returns the change data capture configuration for the HumanResources.Employee table.

USE AdventureWorks2012;  
GO  
EXECUTE sys.sp_cdc_help_change_data_capture   
    @source_schema = N'HumanResources',   
    @source_name = N'Employee';  
GO  

B.B. すべてのテーブルについて変更データ キャプチャの構成情報を取得するReturning change data capture configuration information for all tables

次の例では、変更が呼び出し元がデータにアクセスする権限が含まれているデータベースで有効になっているテーブルのすべての構成情報を返します。The following example returns configuration information for all enabled tables in the database that contain change data that the caller is authorized to access.

USE AdventureWorks2012;  
GO  
EXECUTE sys.sp_cdc_help_change_data_capture;  
GO