sys.sp_cdc_generate_wrapper_function (Transact-SQL)

Gera scripts para criar funções de wrapper para as funções de consulta de captura de dados de alteração disponíveis no SQL Server. A API que tem suporte nos wrappers gerados habilita o intervalo de consulta a ser especificado como um intervalo de datetime. Isso torna a função adequada para uso em muitos aplicativos de data warehouse, inclusive os que são desenvolvidos pelos designers de pacote do Integration Services e que usam a tecnologia Change Data Capture para determinar carga incremental.

Convenções da sintaxe Transact-SQL

Sintaxe

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'
  É a instância de captura para a qual os scripts serão gerados. capture_instance é sysname e tem um valor padrão de NULL. Se um valor for omitido ou explicitamente definido como NULL, serão gerados scripts de wrapper para todas as instâncias de captura.

• [ @closed\_high\_end\_point= ] high_end_pt_flag
  É o bit de sinalizador que indica se as alterações que têm um horário de confirmação igual ao ponto de extremidade alto serão incluídas dentro do intervalo de extração pelo procedimento gerado. high_end_pt_flag é bit e tem um valor padrão de 1, que indica que o ponto de extremidade deve ser incluído. Um valor de 0 indica que todas as horas de confirmação serão estritamente anteriores ao ponto de extremidade alto.

• [ @column\_list= ] 'column_list'
  É uma lista de colunas capturadas a serem incluídas no conjunto de resultados, que é retornado pela função de wrapper. column_list é nvarchar(max) e tem um valor padrão de NULL. Quando NULL for especificado, todas as colunas capturadas serão incluídas.

• [ @update\_flag\_list= ] 'update_flag_list'
  É a lista de colunas incluídas para as quais um sinalizador de atualização é incluído no conjunto de resultados retornado pela função wrapper. update_flag_list é nvarchar(max) e tem um valor padrão de NULL. Quando NULL for especificado, nenhum sinalizador de atualização será incluído.

Valores de código de retorno

0 (êxito) ou 1 (falha)

Conjuntos de resultados

Nome da coluna	Tipo de coluna	Descrição
function_name	nvarchar(145)	Nome da função gerada.
create_script	nvarchar(max)	É o script que cria a função de wrapper da instância de captura.

Comentários

O script que cria a função para incluir a consulta de todas as alterações para uma instância de captura sempre é gerado. Se a instância de captura oferecer suporte a consultas das alterações puras, também será gerado o script para gerar um wrapper para essa consulta.

Exemplos

O exemplo a seguir mostra como é possível usar sys.sp_cdc_generate_wrapper_function para criar 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
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;

Consulte também

Referência

Procedimentos armazenados de captura de dados de alteração (Transact-SQL)

Conceitos

Change Data Capture (SSIS)