sys.sp_cdc_generate_wrapper_function (Transact-SQL)

Generiert Skripts zur Erstellung von Wrapperfunktionen für die in SQL Server verfügbaren Change Data Capture-Abfragefunktionen. Die API, die in den generierten Wrappern unterstützt wird, ermöglicht es, das Abfrageintervall als datetime-Intervall anzugeben. Daher eignet sich die Funktion für viele Warehousing-Anwendungen, einschließlich Warehousing-Anwendungen, die von Integration Services-Paketentwicklern entwickelt werden, die Change Data Capture-Technologie zum Bestimmen von inkrementellem Laden verwenden.

Transact-SQL-Syntaxkonventionen

Syntax

sys.sp_cdc_generate_wrapper_function
    [ [ @capture_instance sysname = ] 'capture_instance'
    [ , [ @closed_high_end_point = ] closed_high_end_pt
    [ , [ @column_list = ] 'column_list'

    [ , [ @update_flag_list = ] 'update_flag_list'

Argumente

• [ @capture\_instance= ] 'capture_instance'
  Die Aufzeichnungsinstanz, für die Skripts generiert werden sollen. capture_instance ist vom Datentyp sysname. Der Standardwert ist NULL. Wenn ein Wert weggelassen oder explizit auf NULL gesetzt wird, werden Wrapperskripts für alle Aufzeichnungsinstanzen generiert.

• [ @closed\_high\_end\_point= ] high_end_pt_flag
  Das Flagbit, das angibt, ob Änderungen, deren Commitzeit gleich dem oberen Endpunkt ist, von der generierten Prozedur innerhalb des Extrahierungsintervalls eingeschlossen werden sollen. high_end_pt_flag ist vom Datentyp bit. Der Standardwert 1 gibt an, dass der Endpunkt eingeschlossen werden soll. Ein Wert von 0 gibt an, dass alle Commitzeiten unter dem oberen Endpunkt liegen müssen.

• [ @column\_list= ] 'column_list'
  Eine Liste erfasster Spalten, die in das Resultset eingeschlossen werden sollen, das von der Wrapperfunktion zurückgegeben wird. column_list ist vom Datentyp nvarchar(max). Der Standardwert ist NULL. Bei Angabe von NULL werden alle aufgezeichneten Spalten eingeschlossen.

• [ @update\_flag\_list= ] 'update_flag_list'
  Eine Liste enthaltener Spalten, für die das von der Wrapperfunktion zurückgegebene Resultset ein Updateflag enthält. update_flag_list ist vom Datentyp nvarchar(max). Der Standardwert ist NULL. Bei Angabe von NULL werden keine Updateflags eingeschlossen.

Rückgabecodewerte

0 (Erfolg) oder 1 (Fehler)

Resultsets

Spaltenname	Spaltentyp	Beschreibung
function_name	nvarchar(145)	Name der generierten Funktion.
create_script	nvarchar(max)	Das Skript, mit dem die Wrapperfunktion der Aufzeichnungsinstanz erstellt wird.

Hinweise

Das Skript zur Erstellung der Wrapperfunktion für eine Abfrage aller Änderungen für eine Aufzeichnungsinstanz wird immer generiert. Wenn die Aufzeichnungsinstanz Abfragen für Nettoänderungen unterstützt, wird auch das Skript zur Generierung einer Wrapperfunktion für diese Abfrage generiert1.

Beispiele

Das folgende Beispiel zeigt, wie Sie mit sys.sp_cdc_generate_wrapper_function Wrapper für alle Change Data Capture-Funktionen erstellen.

DECLARE @wrapper_functions TABLE (
    function_name sysname,
    create_script nvarchar(max));

INSERT INTO @wrapper_functions
EXEC sys.sp_cdc_generate_wrapper_function;

DECLARE @create_script nvarchar(max);
DECLARE #hfunctions CURSOR LOCAL fast_forward
FOR 
    SELECT create_script FROM @wrapper_functions;

OPEN #hfunctions;
FETCH #hfunctions INTO @create_script;
WHILE (@@fetch_status <> -1)
BEGIN
    EXEC sp_executesql @create_script
    FETCH #hfunctions INTO @create_script
END;

CLOSE #hfunctions;
DEALLOCATE #hfunctions;

Siehe auch

Verweis

Gespeicherte Prozeduren für Change Data Capture (Transact-SQL)

Konzepte

Change Data Capture (SSIS)