sys.sp_cdc_generate_wrapper_function (Transact-SQL)

Aplica-se a: SQL Server

Gera scripts para criar funções wrapper para as funções de consulta de captura de dados de alteração disponíveis no SQL Server. A API suportada nos wrappers gerados permite especificar o intervalo de consulta como um intervalo de data-hora. Esta especificação torna a função adequada para uso em muitas aplicações de armazenamento, incluindo aquelas desenvolvidas por designers de pacotes da Integration Services que utilizam tecnologia de captura de dados de alterações para determinar a carga incremental.

Para mais informações sobre as funções geradas por sys.sp_cdc_generate_wrapper_function, veja sys.fn_all_changes_<capture_instance> e sys.fn_net_changes_<capture_instance>.

Transact-SQL convenções de sintaxe

Syntax

sys.sp_cdc_generate_wrapper_function
    [ [ @capture_instance = ] N'capture_instance' ]
    [ , [ @closed_high_end_point = ] closed_high_end_point ]
    [ , [ @column_list = ] N'column_list' ]
    [ , [ @update_flag_list = ] N'update_flag_list' ]
[ ; ]

Arguments

[ @capture_instance = ] N'capture_instance'

A instância de captura para a qual os scripts são gerados @capture_instance é sysname e tem um valor padrão de NULL. Se um valor for omitido ou explicitamente definido como NULL, são gerados scripts wrapper para todas as instâncias de captura.

[ @closed_high_end_point = ] closed_high_end_point

O bit de bandeira que indica se alterações com tempo de commit igual ao extremo superior são incluídas no intervalo de extração pelo procedimento gerado. @closed_high_end_point é bit e tem um valor padrão de 1, o que indica que o endpoint deve ser incluído. Um valor de 0 indica que todos os tempos de commit são estritamente inferiores ao ponto final superior.

[ @column_list = ] N'column_list'

Uma lista das colunas capturadas incluída no conjunto de resultados que é devolvida pela função wrapper. @column_list é nvarchar(max) e tem um valor padrão de NULL. Quando NULL especificado, todas as colunas capturadas são incluídas.

[ @update_flag_list = ] N'update_flag_list'

Uma lista de colunas incluídas para as quais está incluído um flag de atualização no conjunto de resultados devolvido pela função wrapper. @update_flag_list é nvarchar(max) e tem um valor padrão de NULL. Quando NULL especificado, não são incluídas bandeiras de atualização.

Valores de código de retorno

0 (sucesso) ou 1 (fracasso).

Conjunto de resultados

Remarks

O script que cria a função para envolver a consulta de todas as alterações para uma instância de captura é sempre gerado. Se a instância de captura suportar consultas net-changes, também é gerado o script para gerar um wrapper para esta consulta.

Examples

O exemplo seguinte mostra como pode criar sys.sp_cdc_generate_wrapper_function wrappers para todas as funções de captura de dados de alteração.

DECLARE @wrapper_functions TABLE (
    function_name SYSNAME,
    create_script NVARCHAR (MAX));

INSERT INTO @wrapper_functions
EXECUTE sys.sp_cdc_generate_wrapper_function;

DECLARE @create_script AS 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
        EXECUTE sp_executesql @create_script;
        FETCH #hfunctions INTO @create_script;
    END

CLOSE #hfunctions;

DEALLOCATE #hfunctions;

Conteúdo relacionado

• Alterar procedimentos armazenados de captura de dados (Transact-SQL)
• Captura de Dados de Alteração (SSIS)