sys.sp_cdc_disable_table (Transact-SQL)

適用対象:SQL Server

指定したソース テーブルの変更データ キャプチャと、現在のデータベース内のキャプチャ インスタンスを無効にします。 変更データ キャプチャは、SQL Server のすべてのエディションで使用できるわけではありません。 SQL Server の各エディションでサポートされる機能の一覧については、「SQL Server 2022 の各エディションとサポートされている機能」を参照してください。

Transact-SQL 構文表記規則

構文

sys.sp_cdc_disable_table
    [ @source_schema = ] 'source_schema'
      , [ @source_name = ] 'source_name'
    [ , [ @capture_instance = ] { 'capture_instance' | 'all' } ]
[ ; ]

引数

[ @source_schema = ] 'source_schema'

ソース テーブルが含まれているスキーマの名前。 @source_schemaは sysname で、既定値はなく、NULL..

@source_schemaは、現在のデータベースに存在する必要があります。

[ @source_name = ] 'source_name'

変更データ キャプチャを無効にするソース テーブルの名前。 @source_nameは sysname で、既定値はなく、NULL..

@source_nameは、現在のデータベースに存在する必要があります。

[ @capture_instance = ] { 'capture_instance' |'all' }

指定したソース テーブルに対して無効にするキャプチャ インスタンスの名前。 @capture_instanceは sysname であり、NULL..

指定するとall、@source_nameに定義されているすべてのキャプチャ インスタンスが無効になります。

リターン コードの値

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

結果セット

ありません。

解説

sys.sp_cdc_disable_table は、指定されたソース テーブルとキャプチャ インスタンスに関連付けられている変更データ キャプチャ変更テーブルとシステム関数を削除します。 指定したキャプチャ インスタンスに関連付けられている行が変更データ キャプチャ システム テーブルから削除され、sys.tables カタログ ビューのテーブル エントリの列が次のように0設定is_tracked_by_cdcされます。

アクセス許可

db_owner 固定データベース ロール内でメンバーシップが必要です。

次の例では、テーブルの変更データ キャプチャを HumanResources.Employee 無効にします。

USE AdventureWorks2022;
GO

EXECUTE sys.sp_cdc_disable_table
    @source_schema = N'HumanResources',
    @source_name = N'Employee',
    @capture_instance = N'HumanResources_Employee';