sys.sp_cdc_enable_table (Transact-SQL)

  • Artikel

Aktiviert Change Data Capture für die angegebene Quelltabelle in der aktuellen Datenbank. Wenn eine Tabelle für Change Data Capture aktiviert ist, wird für jeden Vorgang der Datenbearbeitungssprache (Data Manipulation Language, DML), der auf die Tabelle angewendet wird, ein Datensatz in das Transaktionsprotokoll geschrieben. Der Change Data Capture-Prozess ruft diese Informationen aus dem Protokoll ab und schreibt sie in die Änderungstabellen, auf die über eine Reihe von Funktionen zugegriffen wird.

Change Data Capture ist nicht in jeder Edition von Microsoft SQL Server verfügbar. Eine Liste der Funktionen, die von den Editionen von SQL Server unterstützt werden, finden Sie unter Von den SQL Server 2012-Editionen unterstützte Funktionen.

Themenlink (Symbol) Transact-SQL-Syntaxkonventionen

Syntax

sys.sp_cdc_enable_table 
  [ @source_schema = ] 'source_schema', 
  [ @source_name = ] 'source_name' ,
  [,[ @capture_instance = ] 'capture_instance' ]
  [,[ @supports_net_changes = ] supports_net_changes ]
  , [ @role_name = ] 'role_name'
  [,[ @index_name = ] 'index_name' ]
  [,[ @captured_column_list = ] 'captured_column_list' ]
  [,[ @filegroup_name = ] 'filegroup_name' ]
  [,[ @allow_partition_switch = ] 'allow_partition_switch' ]
  [;]

Argumente

  • [ @source_schema = ] 'source_schema'
    Der Name des Schemas, zu dem die Quelltabelle gehört. source_schema ist vom Datentyp sysname, hat keinen Standardwert und darf nicht NULL sein.

  • [ @source_name = ] 'source_name'
    Entspricht dem Namen der Quelltabelle, in der Change Data Capture zu aktivieren ist. source_name ist vom Datentyp sysname, hat keinen Standardwert und darf nicht NULL sein.

    source_name muss in der aktuellen Datenbank vorhanden sein. Tabellen im CDC-Schema können nicht für Change Data Capture aktiviert werden.

  • [ @role_name = ] 'role_name'
    Entspricht dem Namen der Datenbankrolle zum Sperren des Zugriffs auf die Änderungsdaten. role_name ist sysname und obligatorisch. Wenn der Parameter explizit auf NULL festgelegt ist, wird keine Gatingrolle verwendet, um den Zugriff auf Änderungsdaten einzuschränken.

    Wenn die Rolle derzeit vorhanden ist, wird sie verwendet. Ist die Rolle nicht vorhanden, wird versucht, eine Datenbankrolle mit dem angegebenen Namen zu erstellen. Vor dem Versuch zur Erstellung der Rolle wird der Rollenname um die in der Zeichenfolge rechts befindlichen Leerstellen gekürzt. Wenn der Aufrufer nicht berechtigt ist, Rollen in der Datenbank zu erstellen, tritt bei der gespeicherten Prozedur ein Fehler auf.

  • [ @capture_instance = ] 'capture_instance'
    Entspricht dem Namen der Aufzeichnungsinstanz, die für die Benennung der instanzspezifischen Change Data Capture-Objekte verwendet wird. capture_instance ist sysname und darf nicht NULL sein.

    Sofern nicht angegeben wird der Name vom Quellschemanamen sowie dem Quelltabellennamen im Format schemaname_sourcename abgeleitet. capture_instance darf nicht länger sein als 100 Zeichen und muss innerhalb der Datenbank eindeutig sein. Unabhängig davon, ob angegeben oder abgeleitet, wird capture_instance um die in der Zeichenfolge rechts befindlichen Leerstellen gekürzt.

    Eine Quelltabelle kann maximal zwei Aufzeichnungsinstanzen aufweisen. Weitere Informationen finden Sie unter sys.sp_cdc_help_change_data_capture (Transact-SQL).

  • [ @supports_net_changes = ] supports_net_changes
    Gibt an, ob die Unterstützung zum Abfragen von Nettoänderungen für diese Aufzeichnungsinstanz zu aktivieren ist. supports_net_changes ist bit. Der Standardwert ist 1, wenn die Tabelle über einen Primärschlüssel oder über einen eindeutigen Index verfügt, der mithilfe des @index\_name-Parameters identifiziert wurde. Andernfalls hat der Parameter den Standardwert 0.

    Bei 0 werden nur die Unterstützungsfunktionen zum Abfragen aller Änderungen generiert.

    Bei 1 werden auch die Funktionen generiert, die zum Abfragen der Nettoänderungen erforderlich sind.

    Wenn supports_net_changes auf 1 festgelegt ist, muss index_name angegeben sein, oder die Quelltabelle muss über einen definierten Primärschlüssel verfügen.

  • [ @index_name = ] **'**index_name'
    Entspricht dem Namen eines eindeutigen Indexes zur eindeutigen Identifizierung von Zeilen in der Quelltabelle. index_name ist sysname und kann NULL sein. Falls angegeben, muss index_name ein gültiger Index für die Quelltabelle sein. Wenn index_name angegeben wird, haben die identifizierten Indexspalten Vorrang vor anderen definierten Primärschlüsselspalten, wie bereits der eindeutige Zeilenbezeichner für die Tabelle.

  • [ @captured_column_list = ] 'captured_column_list'
    Identifiziert die Quelltabellenspalten, die in die Änderungstabelle aufzunehmen sind. captured_column_list ist nvarchar(max) und kann NULL sein. Wenn der Wert NULL ist, werden alle Spalten in der Änderungstabelle eingeschlossen.

    Spaltennamen müssen gültige Spalten in der Quelltabelle sein. Die in einem Primärschlüsselindex oder in einem Index, auf den von index_name verwiesen wird, definierten Spalten müssen eingeschlossen werden.

    captured_column_list ist eine durch Trennzeichen getrennte Liste mit Spaltennamen. Einzelne Spaltennamen innerhalb der Liste können optional mit doppelten Anführungszeichen ("") oder eckigen Klammern ([]) angegeben werden. Wenn ein Spaltenname ein eingebettetes Komma enthält, muss er in Anführungszeichen eingeschlossen sein.

    captured_column_list kann die folgenden reservierten Spaltennamen nicht enthalten: __$start_lsn, __$end_lsn, __$seqval, __$operation und __$update_mask.

  • [ @filegroup_name = ] 'filegroup_name'
    Entspricht der Dateigruppe, die für die Änderungstabelle zu verwenden ist, die für die Aufzeichnungsinstanz erstellt wurde. filegroup_name ist sysname und kann NULL sein. Falls angegeben, muss filegroup_name für die aktuelle Datenbank definiert werden. Wenn der Wert NULL ist, wird die Standarddateigruppe verwendet.

    Es wird empfohlen, eine separate Dateigruppe für Change Data Capture-Änderungstabellen zu erstellen.

  • [ @allow_partition_switch= ] 'allow_partition_switch'
    Gibt an, ob der SWITCH PARTITION-Befehl von ALTER TABLE für eine Tabelle ausgeführt werden kann, die für Change Data Capture aktiviert ist. allow_partition_switch ist vom Datentyp bit. Der Standardwert ist 1.

    Bei nicht partitionierten Tabellen lautet die Schaltereinstellung immer 1, und die tatsächliche Einstellung wird ignoriert. Wenn der Schalter für eine nicht partitionierte Tabelle explizit auf 0 festgelegt ist, wird Warnung 22857 ausgegeben. Dies zeigt an, dass die Schaltereinstellung ignoriert wurde. Wenn der Schalter für eine partitionierte Tabelle explizit auf 0 festgelegt ist, wird die Warnung 22356 ausgegeben. Diese zeigt an, dass SWITCH PARTITION-Vorgänge für die Quelltabelle nicht zulässig sind. Wenn die Schaltereinstellung entweder explizit auf 1 festgelegt und der Standardwert 1 zugelassen und die aktivierte Tabelle partitioniert ist, wird die Warnung 22855 ausgegeben. Diese zeigt an, dass Partitionsschalter nicht blockiert werden. Falls Partitionsschalter auftreten, werden die aus dem Schalter resultierenden Änderungen von Change Data Capture nicht nachverfolgt. Dies führt bei der Nutzung der Änderungsdaten zu Inkonsistenzen.

    Wichtiger HinweisWichtig

    SWITCH PARTITION ist ein Metadatenvorgang, verursacht jedoch Datenänderungen. Die mit diesem Vorgang verbundenen Datenänderungen werden nicht in den Change Data Capture-Änderungstabellen aufgezeichnet. Beispiel: An einer Tabelle mit drei Partitionen werden Änderungen vorgenommen. Mit dem Aufzeichnungsprozess werden Einfüge-, Update- und Löschvorgänge verfolgt, die Benutzer in der Tabelle ausführen. Wenn jedoch eine Partition in eine andere Tabelle ausgelagert wird (z. B. zur Durchführung einer Massenlöschung), werden die verschobenen Zeilen in der Änderungstabelle nicht als gelöschte Zeilen aufgezeichnet. Wenn der Tabelle eine neue Partition mit vorab ausgefüllten Zeilen hinzugefügt wird, werden diese Zeilen auch nicht in der Änderungstabelle erfasst. Dies kann zu inkonsistenten Daten führen, wenn die Änderungen von einer Anwendung belegt und auf ein Ziel angewendet werden.

Rückgabecodewerte

0 (Erfolg) oder 1 (Fehler)

Resultsets

Kein

Hinweise

Bevor Sie eine Tabelle für Change Data Capture aktivieren können, muss die Datenbank aktiviert sein. Um festzustellen, ob die Datenbank für Change Data Capture aktiviert ist, fragen Sie die is_cdc_enabled-Spalte in der sys.databases-Katalogsicht ab. Um die Datenbank zu aktivieren, verwenden Sie die gespeicherte Prozedur sys.sp_cdc_enable_db.

Wenn Change Data Capture für eine Tabelle aktiviert wird, werden eine Änderungstabelle und eine oder zwei Abfragefunktionen generiert. Die Änderungstabelle dient als Repository für die Änderungen der Quelltabelle, die durch den Aufzeichnungsprozess aus dem Transaktionsprotokoll extrahiert wurden. Die Abfragefunktionen werden verwendet, um Daten aus der Änderungstabelle zu extrahieren. Die Namen dieser Funktionen werden auf folgende Weisen vom capture_instance-Parameter abgeleitet:

  • Funktion für alle Änderungen: cdc.fn_cdc_get_all_changes_<capture_instance>

  • Funktion für Nettoänderungen: cdc.fn_cdc_get_net_changes_<capture_instance>

sys.sp_cdc_enable_table erstellt außerdem die Aufzeichnungs- und Cleanupaufträge für die Datenbank, wenn die Quelltabelle als erste Datenbanktabelle für Change Data Capture aktiviert wird und keine Transaktionsveröffentlichungen für diese Datenbank vorhanden sind. Sie legt die is_tracked_by_cdc-Spalte in der sys.tables-Katalogsicht auf 1 fest.

HinweisHinweis

Der SQL Server-Agent muss nicht aktiv sein, wenn Change Data Capture für eine Tabelle aktiviert wird. Das Transaktionsprotokoll und in die Änderungstabelle geschriebene Einträge werden jedoch erst vom Aufzeichnungsprozess verarbeitet, wenn der SQL Server-Agent ausgeführt wird.

Berechtigungen

Erfordert die Mitgliedschaft in der festen Datenbankrolle db_owner.

Beispiele

A.Aktivieren von Change Data Capture durch das Angeben von nur erforderlichen Parametern

Im folgenden Beispiel wird Change Data Capture für die HumanResources.Employee-Tabelle aktiviert. Nur die erforderlichen Parameter werden angegeben.

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

B.Aktivieren von Change Data Capture durch das Angeben zusätzlicher optionaler Parameter

Im folgenden Beispiel wird Change Data Capture für die HumanResources.Department-Tabelle aktiviert. Alle Parameter außer @allow\_partition\_switch werden angegeben.

USE AdventureWorks2012;
GO
EXEC sys.sp_cdc_enable_table
    @source_schema = N'HumanResources'
  , @source_name = N'Department'
  , @role_name = N'cdc_admin'
  , @capture_instance = N'HR_Department' 
  , @supports_net_changes = 1
  , @index_name = N'AK_Department_Name' 
  , @captured_column_list = N'DepartmentID, Name, GroupName' 
  , @filegroup_name = N'PRIMARY';
GO

Siehe auch

Verweis

sys.sp_cdc_disable_table (Transact-SQL)

sys.sp_cdc_help_change_data_capture (Transact-SQL)

cdc.fn_cdc_get_all_changes_<capture_instance> (Transact-SQL)

cdc.fn_cdc_get_net_changes_<capture_instance> (Transact-SQL)

sys.sp_cdc_help_jobs (Transact-SQL)