sys.sp_cdc_generate_wrapper_function (Transact-SQL)

Genera scripts para crear funciones de contenedor para las funciones de consulta de captura de datos modificados que están disponibles en SQL Server. La API que se admite en los contenedores generados permite especificar el intervalo de la consulta como un intervalo de fecha y hora. Esto hace que la función sea idónea para su uso en muchas aplicaciones de almacenamiento de datos, incluidas las que se desarrollan con diseñadores de paquetes de Integration Services que utilizan la tecnología de captura de datos modificados para determinar la carga incremental.

Convenciones de sintaxis de Transact-SQL

Sintaxis

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'

Argumentos

• [ @capture\_instance= ] 'capture_instance'
  Es la instancia de captura para la que se van a generar los scripts. capture_instance es de tipo sysname y su valor predeterminado es NULL. Si se omite un valor o se establece explícitamente en NULL, los scripts de contenedor se generan para todas las instancias de captura

• [ @closed\_high\_end\_point= ] high_end_pt_flag
  Es el bit de marca que indica si el procedimiento generado incluirá dentro del intervalo de extracción los cambios que tengan una fecha y hora de confirmación igual al extremo superior. high_end_pt_flag es de tipo bit y su valor predeterminado es 1, lo que indica que se debe incluir el extremo. El valor 0 indica que todas las fechas y horas de confirmación serán estrictamente menores que el extremo superior.

• [ @column\_list= ] 'column_list'
  Es una lista de las columnas capturadas que se van a incluir en el conjunto de resultados devuelto por la función de contenedor. column_list es de tipo nvarchar(max) y su valor predeterminado es NULL. Cuando se especifica NULL, se incluyen todas las columnas capturadas.

• [ @update\_flag\_list= ] 'update_flag_list'
  Es una lista de las columnas incluidas para las que se incluye una marca de actualización en el conjunto de resultados devuelto por la función de contenedor. update_flag_list es de tipo nvarchar(max) y su valor predeterminado es NULL. Cuando se especifica NULL, no se incluyen marcas de actualización.

Valores de código de retorno

0 (correcto) o 1 (error)

Conjuntos de resultados

Nombre de columna	Tipo de columna	Descripción
function_name	nvarchar(145)	Nombre de la función generada.
create_script	nvarchar(max)	Es el script que crea la función de contenedor de la instancia de captura.

Comentarios

El script que crea la función para contener la consulta de todos los cambios para una instancia de captura siempre se genera. Si la instancia de captura admite consultas de cambios de red, el script para generar un contenedor para esta consulta también se genera.

Ejemplos

El ejemplo siguiente muestra cómo se puede utilizar sys.sp_cdc_generate_wrapper_function para crear contenedores para todas las funciones de captura de datos modificados.

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;

Vea también

Referencia

Procedimientos almacenados de captura de datos modificados (Transact-SQL)

Conceptos

Captura de datos modificados (SSIS)