Partilhar via


Componente Script

Aplica-se a:SQL Server SSIS Integration Runtime em Azure Data Factory

O componente Script hospeda o script e permite que um pacote inclua e execute código de script personalizado. Você pode usar o componente Script em pacotes para as seguintes finalidades:

  • Aplique várias transformações aos dados em vez de usar várias transformações no fluxo de dados. Por exemplo, um script pode adicionar os valores em duas colunas e, em seguida, calcular a média da soma.

  • Acesse regras de negócios em um assembly .NET existente. Por exemplo, um script pode aplicar uma regra de negócios que especifica o intervalo de valores válidos em uma coluna Rendimento .

  • Use fórmulas e funções personalizadas, além das funções e operadores que a gramática de expressão do Integration Services fornece. Por exemplo, valide números de cartão de crédito que usam a fórmula LUHN.

  • Valide dados de coluna e ignore registros que contenham dados inválidos. Por exemplo, um script pode avaliar a razoabilidade de um valor de postagem e pular registros com valores extremamente altos ou baixos.

O componente Script fornece uma maneira fácil e rápida de incluir funções personalizadas em um fluxo de dados. No entanto, se você planeja reutilizar o código de script em vários pacotes, considere programar um componente personalizado em vez de usar o componente Script. Para obter mais informações, consulte Desenvolvendo um componente de fluxo de dados personalizado.

Observação

Se o componente Script contiver um script que tenta ler o valor de uma coluna que é NULL, o componente Script falhará quando você executar o pacote. Recomendamos que o script use o IsNull método para determinar se a coluna é NULL antes de tentar ler o valor da coluna.

O componente Script pode ser usado como origem, transformação ou destino. Este componente suporta uma entrada e várias saídas. Dependendo de como o componente é usado, ele suporta uma entrada ou saídas ou ambas. O script é invocado por cada linha na entrada ou saída.

  • Se usado como fonte, o componente Script suporta várias saídas.

  • Se usado como uma transformação, o componente Script suporta uma entrada e várias saídas.

  • Se usado como destino, o componente Script suporta uma entrada.

O componente Script não suporta saídas de erro.

Depois de decidir que o componente Script é a escolha apropriada para seu pacote, você precisa configurar as entradas e saídas, desenvolver o script que o componente usa e configurar o próprio componente.

Noções básicas sobre os modos de componente de script

No Designer SSIS, o componente Script tem dois modos: modo de design de metadados e modo de design de código. No modo de design de metadados, você pode adicionar e modificar as entradas e saídas do componente Script, mas não pode escrever código. Depois que todas as entradas e saídas estiverem configuradas, você alternará para o modo de design de código para escrever o script. O componente Script gera automaticamente o código base a partir dos metadados das entradas e saídas. Se você alterar os metadados depois que o componente Script gerar o código base, seu código pode não ser mais compilado porque o código base atualizado pode ser incompatível com seu código.

Escrevendo o script que o componente usa

O componente Script usa o Microsoft Visual Studio Tools for Applications (VSTA) como o ambiente no qual você escreve os scripts. Você acessa o VSTA a partir do Editor de transformação de script.

O componente Script fornece um projeto VSTA que inclui uma classe gerada automaticamente, chamada ScriptMain, que representa os metadados do componente. Por exemplo, se o componente Script for usado como uma transformação que tenha três saídas, ScriptMain incluirá um método para cada saída. ScriptMain é o ponto de entrada para o script.

O VSTA inclui todos os recursos padrão do ambiente do Visual Studio, como o editor do Visual Studio codificado por cores, o IntelliSense e o Pesquisador de Objetos. O script que o componente Script usa é armazenado na definição do pacote. Quando você está criando o pacote, o código de script é gravado temporariamente em um arquivo de projeto.

VSTA suporta as linguagens de programação Microsoft Visual C# e Microsoft Visual Basic.

Para obter informações sobre como programar o componente Script, consulte Estendendo o fluxo de dados com o componente Script. Para obter informações mais específicas sobre como configurar o componente Script como origem, transformação ou destino, consulte Desenvolvendo tipos específicos de componentes de script. Para obter exemplos adicionais, como um destino ODBC que demonstre o uso do componente Script, consulte Exemplos adicionais de componentes de script.

Observação

Ao contrário das versões anteriores, em que era possível indicar se os scripts foram pré-compilados, todos os scripts são pré-compilados no SQL Server 2008 Integration Services (SSIS) e em versões posteriores. Quando um script é pré-compilado, o mecanismo de linguagem não é carregado em tempo de execução e o pacote é executado mais rapidamente. No entanto, os arquivos binários pré-compilados consomem espaço em disco significativo.

Configurando o componente Script

Você pode configurar o componente Script das seguintes maneiras:

  • Selecione as colunas de entrada a serem referenciadas.

    Observação

    Você pode configurar apenas uma entrada ao usar o Designer SSIS.

  • Forneça o script que o componente executa.

  • Especifique a linguagem de script.

  • Forneça listas separadas por vírgulas de variáveis de leitura apenas e leitura/gravação.

  • Adicione mais saídas e adicione colunas de saída às quais o script atribui.

Você pode definir propriedades por meio do SSIS Designer ou programaticamente.

Configurando o Componente Script no Designer

Para obter mais informações sobre como definir essas propriedades no Designer SSIS, clique no seguinte tópico:

Configurando o componente Script programaticamente

Para obter mais informações sobre as propriedades que você pode definir na janela Propriedades ou programaticamente, clique em um dos seguintes tópicos:

Para obter mais informações sobre como definir propriedades, clique em um dos seguintes tópicos:

Selecionar tipo de componente de script

Use a caixa de diálogo Selecionar Tipo de Componente de Script para especificar se deseja criar uma Transformação de Script pré-configurada para uso como origem, transformação ou destino.

Para saber mais sobre o componente Script, consulte Configurando o componente Script no Editor do componente Script. Para saber mais sobre como programar o componente Script, consulte Estendendo o fluxo de dados com o componente Script.

Opções

Sua seleção de Origem, Destino ou Transformação afeta a configuração da Transformação de Script e as páginas do Editor de Transformação de Script.

Editor de Transformação de Scripts (página Gerenciadores de Conexões)

Use a página Gerenciadores de Conexões do Editor de Transformação de Script para especificar quaisquer conexões que serão usadas pelo script.

Para saber mais sobre o componente Script, consulte Configurando o componente Script no Editor do componente Script. Para saber mais sobre como programar o componente Script, consulte Estendendo o fluxo de dados com o componente Script.

Opções

Gerenciadores de conexões
Exiba a lista de conexões disponíveis para uso pelo script.

Nome
Digite um nome exclusivo e descritivo para a conexão.

Gestor de Ligações
Selecione na lista de gerenciadores de conexões disponíveis ou selecione <Nova conexão> para abrir a caixa de diálogo Adicionar Gerenciador de Conexões SSIS .

Descrição
Digite uma descrição para a conexão.

Adicionar
Adicione outra conexão à lista Gerenciadores de conexões .

Remover
Remova a conexão selecionada da lista Gerenciadores de conexões .

Editor de Transformação de Scripts (Página de Colunas de Entrada)

Use a página Colunas de Entrada da caixa de diálogo Editor de Transformação de Script para definir propriedades em colunas de entrada.

Observação

A página Colunas de entrada não é exibida para componentes de origem, que têm saídas, mas não entradas.

Para saber mais sobre o componente Script, consulte Configurando o componente Script no Editor do componente Script. Para saber mais sobre como programar o componente Script, consulte Estendendo o fluxo de dados com o componente Script.

Opções

Nome de entrada
Selecione a partir da lista de entradas disponíveis.

Colunas de entrada disponíveis
Usando as caixas de seleção, especifique as colunas que a transformação de script usará.

Coluna de Entrada
Selecione na lista de colunas de entrada disponíveis para cada linha. Suas seleções são refletidas nas seleções de caixa de seleção na tabela Colunas de entrada disponíveis .

Alias de saída
Digite um alias para cada coluna de saída. O padrão é o nome da coluna de entrada; no entanto, você pode escolher qualquer nome exclusivo e descritivo.

Tipo de Utilização
Especifique se a Transformação de Script tratará cada coluna como Somente Leitura ou Leitura/Escrita.

Editor de Transformação de Scripts (Página de Entradas e Saídas)

Use a página Entradas e Saídas da caixa de diálogo Editor de Transformação de Script para adicionar, remover e configurar entradas e saídas para a Transformação de Script.

Observação

Os componentes de origem têm saídas e não há entradas, enquanto os componentes de destino têm entradas, mas não saídas. As transformações têm entradas e saídas.

Para saber mais sobre o componente Script, consulte Configurando o componente Script no Editor do componente Script. Para saber mais sobre como programar o componente Script, consulte Estendendo o fluxo de dados com o componente Script.

Opções

Entradas e saídas
Selecione uma entrada ou saída à esquerda para visualizar suas propriedades na tabela à direita. As propriedades disponíveis para edição variam de acordo com a seleção. Muitas das propriedades exibidas são de apenas leitura. Para obter mais informações sobre as propriedades individuais, consulte os tópicos a seguir.

Propriedades comuns

Propriedades Personalizadas de Transformação

Adicionar saída
Adicione uma saída adicional à lista.

Adicionar coluna
Selecione uma pasta na qual colocar a nova coluna de saída e adicione a coluna clicando em Adicionar Coluna.

Remover saída
Selecione uma saída e remova-a clicando em Remover Saída.

Remover coluna
Selecione uma coluna e remova-a clicando em Remover Coluna.

Editor de Transformação de Script (Página de Script)

Use a guia Script da caixa de diálogo Editor de Transformação de Script para especificar um script e propriedades relacionadas.

Para saber mais sobre o componente Script, consulte Configurando o componente Script no Editor do componente Script. Para saber mais sobre como programar o componente Script, consulte Estendendo o fluxo de dados com o componente Script.

Opções

Propriedades
Exiba e modifique as propriedades da transformação Script. Muitas das propriedades exibidas são de apenas leitura. Você pode modificar as seguintes propriedades:

Valor Descrição
Descrição Descreva a transformação do script em termos de sua finalidade.
LocaleID Especifique a localidade para fornecer informações específicas da região para pedidos e para conversão de data e hora.
Nome Digite um nome descritivo para o componente.
ValidateExternalMetadata Indique se a transformação Script valida os metadados de coluna em relação a fontes de dados externas durante a fase de design. Um valor de false atrasa a validação até o momento da execução.
ReadOnlyVariables Digite uma lista de variáveis, separada por vírgulas, para acesso apenas de leitura pela transformação de script.

Nota: Os nomes das variáveis diferenciam maiúsculas de minúsculas.
ReadWriteVariables Digite uma lista separada por vírgulas de variáveis para acesso de leitura/gravação pela transformação Script.

Nota: Os nomes das variáveis diferenciam maiúsculas de minúsculas.
Linguagem de script Selecione a linguagem de script a ser usada pelo componente Script.

Para definir a linguagem de script padrão para componentes de script e tarefas de script, use a opção Linguagem de script na página Geral da caixa de diálogo Opções .
UserComponentTypeName Especifica a ScriptComponentHost classe e o assembly Microsoft.SqlServer.TxScript que dão suporte à infraestrutura do SQL Server.

Editar script
Use o Microsoft Visual Studio Tools for Applications (VSTA) para criar ou modificar um script.

Transformações do Integration Services

Estendendo o fluxo de dados com o componente de script