Compartilhar via


Componente Script

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

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

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

  • Acessar regras de negócio em um assembly .NET existente. Por exemplo, um script pode aplicar uma regra de negócio que especifica um intervalo de valores válidos em uma coluna Income .

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

  • Validar dados de coluna e ignorar registros que contêm dados inválidos. Por exemplo, um script pode avaliar a racionalidade de um valor de postagem e ignorar registros com quantias extremamente altas ou baixas.

O componente Script fornece um modo fácil e rápido para incluir funções personalizadas em um fluxo de dados. Porém, se você planeja reutilizar o código de script em vários pacotes, deveria considerar programação de 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, esse componente falhará quando você executar o pacote. Recomendamos que o script use o método IsNull para determinar se a coluna é NULL antes de tentar ler o valor da coluna.

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

  • Se usado como origem, o componente Script oferece suporte a várias saídas.

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

  • Se usado como destino, o componente Script oferece suporte a uma entrada.

O componente Script não oferece suporte a saídas de erro.

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

Compreendendo os modos do componente Script

No Designer SSIS , o componente Script tem dois modos: modo do design de metadados e modo do design de código. No modo 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 são configuradas, você troca para o modo do 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, talvez seu código não seja 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 VSTA (Tools for Applications) como o ambiente em que os scripts são escritos. Você acessa o VSTA no Editor de Transformação Scripts. Para obter mais informações, confira Editor de Transformação Scripts (Página Script).

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

O VSTA inclui todos os recursos padrão do ambiente Visual Studio , como o editor Visual Studio codificado por cor, o IntelliSense e o Object Browser. O script usado pelo componente Script é armazenado na definição de pacote. Quando você está projetando o pacote, o código de script é gravado temporariamente em um arquivo de projeto.

O VSTA dá suporte às linguagens de programação Microsoft Visual C# e Microsoft Visual Basic.

Para obter informações sobre como programar o componente Script, consulte Estender o fluxo de dados com o componente de Script. Para obter mais informações específicas sobre como configurar o componente Script como origem, transformação ou destino, consulte Developing Specific Types of Script Components. Para obter exemplos adicionais como um destino de ODBC que demonstra o uso do componente Script, consulte Additional Script Component Examples.

Observação

Ao contrário das versões anteriores em que você podia indicar se os scripts eram 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 no tempo de execução e o pacote é executado mais rapidamente. No entanto, arquivos binários pré-compilados consomem espaço significativo em disco.

Configurando o componente Script

Você pode configurar o componente Script das seguintes maneiras:

  • Selecione as colunas de entrada para referência.

    Observação

    Você pode configurar só uma entrada quando usar o Designer do SSIS .

  • Forneça o script que o componente é executado.

  • Especifique a linguagem do script.

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

  • Adicione mais saídas e adicione colunas de saída atribuídas ao script.

Você pode definir propriedades pelo Designer do SSIS ou programaticamente.

Configurando o componente Script no Designer

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

Configurando o componente Script programaticamente

Para obter mais informações sobre as propriedades que podem ser definidas 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 do Script

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

Para obter mais informações sobre o componente Script, consulte Configurar o componente Script no Editor de Componentes Script. Para obter informações sobre a programação do componente Script, consulte Estender o fluxo de dados com o componente de Script.

Opções

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

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

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

Para obter mais informações sobre o componente Script, consulte Configurar o componente Script no Editor de Componentes Script. Para obter informações sobre a programação do componente Script, consulte Estender o fluxo de dados com o componente de Script.

Opções

Connection managers
Exiba a lista de conexões disponíveis para serem usadas pelo script.

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

Gerenciador de Conexõ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 Scripts (página Colunas de Entrada)

Use a página Colunas de Entrada da caixa de diálogo Editor de Transformação Scripts para definir propriedades nas 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 têm entradas.

Para obter mais informações sobre o componente Script, consulte Configurar o componente Script no Editor de Componentes Script. Para obter informações sobre a programação do componente Script, consulte Estender o fluxo de dados com o componente de Script.

Opções

Nome de entrada
Selecione na lista de entradas disponíveis.

Colunas de Entrada Disponíveis
Usando as caixas de seleção, especifique as colunas que a transformação scripts usará.

Coluna de Entrada
Selecione colunas para cada linha na lista de colunas de entrada disponíveis. As seleções se refletem naquelas da caixa de seleção da 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, é possível escolher qualquer nome descritivo exclusivo.

Tipo de Uso
Especifique se a Transformação Scripts tratará cada coluna como ReadOnly ou ReadWrite.

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

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

Observação

Os componentes de origem possuem saídas e não entradas, enquanto os componentes de destino possuem entradas mas nenhuma saída. Transformações têm entradas e saídas.

Para obter mais informações sobre o componente Script, consulte Configurar o componente Script no Editor de Componentes Script. Para obter informações sobre a programação do componente Script, consulte Estender o fluxo de dados com o componente de Script.

Opções

Inputs and outputs
Selecione uma entrada ou uma saída à esquerda para exibir 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 somente leitura. Para obter mais informações sobre as propriedades individuais, consulte os tópicos abaixo.

Propriedades comuns

Propriedades personalizadas de Transformação

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

Adicionar Coluna
Selecione uma pasta na qual deseja 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 Scripts (página Script)

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

Para obter mais informações sobre o componente Script, consulte Configurar o componente Script no Editor de Componentes Script. Para obter informações sobre a programação do componente Script, consulte Estender o fluxo de dados com o componente de Script.

Opções

Propriedades
Visualize e modifique as propriedades da transformação Scripts. Muitas das propriedades exibidas são somente leitura. Você pode modificar as seguintes propriedades:

Valor Descrição
Descrição Descreva a finalidade da transformação scripts.
LocaleID Especifique a localidade para fornecer informações de solicitação e de conversão de data e hora específicas da região.
Nome Digite um nome descritivo para o componente.
ValidateExternalMetadata Indique se a transformação Scripts deve validar coluna de metadados contra fontes de dados externas em tempo de design. Um valor de false retarda a validação até o momento da execução.
ReadOnlyVariables Digite uma lista de variáveis separada por vírgulas a ser acessada em modo somente leitura pela transformação Scripts.

Observação: nomes de variáveis fazem diferenciação de maiúsculas e minúsculas.
ReadWriteVariables Digite uma lista de variáveis separada por vírgulas a ser acessada em modo leitura/gravação pela transformação Scripts.

Observação: nomes de variáveis fazem diferenciação de maiúsculas e minúsculas.
ScriptLanguage Selecione a linguagem de script a ser usada pelo componente de Script.

Para definir a linguagem de script padrão para componentes 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 classe ScriptComponentHost e o assembly Microsoft.SqlServer.TxScript que dá suporte à infraestrutura SQL Server .

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

Transformações do Integration Services

Estender o fluxo de dados com o componente de Script