Artigo
04/01/2012

Adicionando componentes de fluxo de dados programaticamente

Ao compilar um fluxo de dados, você começa adicionando componentes. Em seguida, você configura esses componentes e os conecta para estabelecer o fluxo de dados em tempo de execução. Esta seção descreve como adicionar um componente à tarefa de fluxo de dados, criar a instância tempo de design do componente e configurar o componente. Para obter informações sobre como conectar componentes, consulte Conectando componentes de fluxo de dados programaticamente.

Adicionando um componente

Chame o método New da coleção ComponentMetaDataCollection para criar um componente novo e adicioná-lo à tarefa de fluxo de dados. Este método retorna a interface IDTSComponentMetaData100 do componente. Contudo, neste momento, o IDTSComponentMetaData100 não contém informações específicas de nenhum componente. Defina a propriedade ComponentClassID para identificar o tipo de componente. A tarefa de fluxo de dados usa o valor dessa propriedade para criar uma instância do componente em tempo de execução.

O valor especificado na propriedade ComponentClassID pode ser o CLSID, o PROGID ou a propriedade CreationName do componente. O CLSID é exibido normalmente na janela Propriedades como o valor da propriedade ComponentClassID do componente. Para obter informações sobre como obter essa propriedade e outras propriedades de componentes disponíveis, consulte Descobrindo componentes de fluxo de dados programaticamente.

Adicionando um componente gerenciado

Não é possível usar o CLSID ou o PROGID para adicionar um dos componentes de fluxo de dados gerenciados ao fluxo de dados, pois esses valores apontam para um wrapper e não para o componente em si. Em vez disso, você pode usar a propriedade CreationName ou a propriedade AssemblyQualifiedName como mostra o exemplo a seguir.

Se você pretende usar a propriedade AssemblyQualifiedName, você deve adicionar uma referência em seu projeto Visual Studio ao assembly que contém o componente gerenciado. Esses assemblies não são listados na guia .NET da caixa de diálogo Adicionar Referência. Normalmente, você deve navegar para localizar o assembly na pasta C:\Program Files\Microsoft SQL Server\100\DTS\PipelineComponents.

Os componentes de fluxo de dados gerenciados embutidos incluem:

ADO.NET Origem
Origem XML
Destino DataReader
Destino SQL Server Compact
Componente Script

O exemplo de código seguinte mostra ambos os modos de adicionar um componente gerenciado ao fluxo de dados:

using System;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Pipeline;
using Microsoft.SqlServer.Dts.Pipeline.Wrapper;

namespace Microsoft.SqlServer.Dts.Samples
{
  class Program
  {
    static void Main(string[] args)
    {
      Microsoft.SqlServer.Dts.Runtime.Package package = new Microsoft.SqlServer.Dts.Runtime.Package();
      Executable e = package.Executables.Add("STOCK:PipelineTask");
      Microsoft.SqlServer.Dts.Runtime.TaskHost thMainPipe = (Microsoft.SqlServer.Dts.Runtime.TaskHost)e;
      MainPipe dataFlowTask = (MainPipe)thMainPipe.InnerObject;

      // The Application object will be used to obtain the CreationName
      //  of a PipelineComponentInfo from its PipelineComponentInfos collection.
      Application app = new Application();

      // Add a first ADO NET source to the data flow.
      //  The CreationName property requires an Application instance.
      IDTSComponentMetaData100 component1 = dataFlowTask.ComponentMetaDataCollection.New();
      component1.Name = "DataReader Source";
      component1.ComponentClassID = app.PipelineComponentInfos["DataReader Source"].CreationName;

      // Add a second ADO NET source to the data flow.
      //  The AssemblyQualifiedName property requires a reference to the assembly.
      IDTSComponentMetaData100 component2 = dataFlowTask.ComponentMetaDataCollection.New();
      component2.Name = "DataReader Source";
      component2.ComponentClassID = typeof(Microsoft.SqlServer.Dts.Pipeline.DataReaderSourceAdapter).AssemblyQualifiedName;
    }
  }
}

Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Pipeline
Imports Microsoft.SqlServer.Dts.Pipeline.Wrapper

Module Module1

  Sub Main()

    Dim package As Microsoft.SqlServer.Dts.Runtime.Package = _
      New Microsoft.SqlServer.Dts.Runtime.Package()
    Dim e As Executable = package.Executables.Add("STOCK:PipelineTask")
    Dim thMainPipe As Microsoft.SqlServer.Dts.Runtime.TaskHost = _
      CType(e, Microsoft.SqlServer.Dts.Runtime.TaskHost)
    Dim dataFlowTask As MainPipe = CType(thMainPipe.InnerObject, MainPipe)

    ' The Application object will be used to obtain the CreationName
    '  of a PipelineComponentInfo from its PipelineComponentInfos collection.
    Dim app As New Application()

    ' Add a first ADO NET source to the data flow.
    '  The CreationName property requires an Application instance.
    Dim component1 As IDTSComponentMetaData100 = _
      dataFlowTask.ComponentMetaDataCollection.New()
    component1.Name = "DataReader Source"
    component1.ComponentClassID = app.PipelineComponentInfos("DataReader Source").CreationName

    ' Add a second ADO NET source to the data flow.
    '  The AssemblyQualifiedName property requires a reference to the assembly.
    Dim component2 As IDTSComponentMetaData100 = _
      dataFlowTask.ComponentMetaDataCollection.New()
    component2.Name = "DataReader Source"
    component2.ComponentClassID = _
      GetType(Microsoft.SqlServer.Dts.Pipeline.DataReaderSourceAdapter).AssemblyQualifiedName

  End Sub

End Module

Criando a instância tempo de design do componente

Chame o método Instantiate para criar a instância tempo de design do componente identificada pela propriedade ComponentClassID. Esse método retorna o objeto CManagedComponentWrapper, que é o wrapper gerenciado para a interface IDTSDesigntimeComponent100.

Sempre que possível, você deve modificar um componente usando os métodos da instância tempo de design em vez de modificar os metadados do componente diretamente. Embora existam itens nos metadados que você deve definir diretamente, como as conexões, em geral não se aconselha modificar os metadados diretamente, pois assim você ignora a capacidade do componente de monitorar e validar alterações.

Atribuindo conexões

Alguns componentes, como o componente Origem OLE DB, requerem uma conexão com dados externos e usam um objeto ConnectionManager existente no pacote para esse propósito. A propriedade Count da coleção RuntimeConnectionCollection indica o número de objetos ConnectionManager em tempo de execução requeridos pelo componente. Se a contagem for maior que zero, o componente precisará de uma conexão. Atribua um gerenciador de conexões do pacote para o componente especificando as propriedades ConnectionManager e Name da primeira conexão no RuntimeConnectionCollection. Note que o nome do gerenciador de conexões na coleção de conexões em tempo de execução deve corresponder ao nome do gerenciador de conexões referenciado do pacote.

Definindo os valores de propriedades personalizadas

Depois de criar a instância tempo de design do componente, chame o método ProvideComponentProperties. Esse método é similar a um construtor por que ele inicializa um componente recém-criado criando suas propriedades personalizadas e seus objetos de entrada e saída. Não chame ProvideComponentProperties mais de uma vez em um componente, pois o componente pode se redefinir e perder qualquer modificação feita em seus metadados anteriormente.

O CustomPropertyCollection do componente contém uma coleção de objetos IDTSCustomProperty100 específicos ao componente. Ao contrário de outros modelos de programação, em que as propriedades de um objeto são sempre visíveis no objeto, os componentes preenchem somente suas coleções de propriedades personalizadas quando você chama o método ProvideComponentProperties. Depois de chamar o método, use o método SetComponentProperty da instância tempo de design do componente para atribuir valores a suas propriedades personalizadas. Esse método aceita um par nome/valor que identifica a propriedade personalizada e fornece seu valor novo.

Inicializando colunas de saída

Depois de adicionar um componente à tarefa e configurá-lo, inicialize a coleção de colunas no IDTSOutput100 do objeto. Essa etapa é especialmente relevante para componentes de origem, mas não pode inicializar as colunas para componentes de transformação e destino, pois geralmente eles dependem das colunas que recebem dos componentes upstream.

Chame o método ReinitializeMetaData para inicializar as colunas nas saídas de um componente de origem. Como os componentes não se conectam automaticamente a fontes de dados externas, chame o método AcquireConnections antes de chamar ReinitializeMetaData para fornecer ao componente acesso a sua fonte de dados externa e a capacidade de preencher os metadados da sua coluna. Finalmente, chame o método ReleaseConnections para liberar a conexão.

Próxima etapa

Depois de adicionar e configurar o componente, a próxima etapa é criar caminhos entre componentes, que é discutido no tópico Criando um caminho entre dois componentes.

Exemplo

O exemplo de código a seguir adiciona o componente Origem OLE DB a uma tarefa de fluxo de dados, cria uma instância tempo de design do componente e configura as propriedades do componente. Esse exemplo requer uma referência adicional ao assembly Microsoft.SqlServer.DTSRuntimeWrap.

using System;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Runtime.Wrapper;
using Microsoft.SqlServer.Dts.Pipeline;
using Microsoft.SqlServer.Dts.Pipeline.Wrapper;

namespace Microsoft.SqlServer.Dts.Samples
{
  class Program
  {
    static void Main(string[] args)
    {
      Runtime.Package package = new Runtime.Package();
      Executable e = package.Executables.Add("STOCK:PipelineTask");
      Runtime.TaskHost thMainPipe = e as Runtime.TaskHost;
      MainPipe dataFlowTask = thMainPipe.InnerObject as MainPipe;
      
      // Add an OLEDB connection manager to the package.
      ConnectionManager cm = package.Connections.Add("OLEDB");
      cm.Name = "OLEDB ConnectionManager";
      cm.ConnectionString = "Data Source=(local);" + 
        "Initial Catalog=AdventureWorks2008R2;Provider=SQLNCLI11.1;" + 
        "Integrated Security=SSPI;"
      
      // Add an OLE DB source to the data flow.
      IDTSComponentMetaData100 component = 
        dataFlowTask.ComponentMetaDataCollection.New();
      component.Name = "OLEDBSource";
      component.ComponentClassID = "DTSAdapter.OleDbSource.2";
      // You can also use the CLSID of the component instead of the PROGID.
      //component.ComponentClassID = "{2C0A8BE5-1EDC-4353-A0EF-B778599C65A0}";

      // Get the design time instance of the component.
      CManagedComponentWrapper instance = component.Instantiate();

      // Initialize the component
      instance.ProvideComponentProperties();

      // Specify the connection manager.
      if (component.RuntimeConnectionCollection.Count > 0)
      {
        component.RuntimeConnectionCollection[0].ConnectionManager = 
          DtsConvert.GetExtendedInterface(package.Connections[0]);
        component.RuntimeConnectionCollection[0].ConnectionManagerID = 
          package.Connections[0].ID;      }

      // Set the custom properties.
      instance.SetComponentProperty("AccessMode", 2);
      instance.SetComponentProperty("SqlCommand", 
        "Select * from Production.Product");

      // Reinitialize the metadata.
      instance.AcquireConnections(null);
      instance.ReinitializeMetaData();
      instance.ReleaseConnections();

      // Add other components to the data flow and connect them.
    }
  }
}

Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Runtime.Wrapper
Imports Microsoft.SqlServer.Dts.Pipeline
Imports Microsoft.SqlServer.Dts.Pipeline.Wrapper

Module Module1

  Sub Main()

    Dim package As Microsoft.SqlServer.Dts.Runtime.Package = _
      New Microsoft.SqlServer.Dts.Runtime.Package()
    Dim e As Executable = package.Executables.Add("STOCK:PipelineTask")
    Dim thMainPipe As Microsoft.SqlServer.Dts.Runtime.TaskHost = _
      CType(e, Microsoft.SqlServer.Dts.Runtime.TaskHost)
    Dim dataFlowTask As MainPipe = CType(thMainPipe.InnerObject, MainPipe)

    ' Add an OLEDB connection manager to the package.
    Dim cm As ConnectionManager = package.Connections.Add("OLEDB")
    cm.Name = "OLEDB ConnectionManager"
    cm.ConnectionString = "Data Source=(local);" & _
      "Initial Catalog=AdventureWorks2008R2;Provider=SQLCLI11.1;" & _
      "Integrated Security=SSPI;"

    ' Add an OLE DB source to the data flow.
    Dim component As IDTSComponentMetaData100 = _
      dataFlowTask.ComponentMetaDataCollection.New()
    component.Name = "OLEDBSource"
    component.ComponentClassID = "DTSAdapter.OleDbSource.2"
    ' You can also use the CLSID of the component instead of the PROGID.
    'component.ComponentClassID = "{2C0A8BE5-1EDC-4353-A0EF-B778599C65A0}";

    ' Get the design time instance of the component.
    Dim instance As CManagedComponentWrapper = component.Instantiate()

    ' Initialize the component.
    instance.ProvideComponentProperties()

    ' Specify the connection manager.
    If component.RuntimeConnectionCollection.Count > 0 Then
      component.RuntimeConnectionCollection(0).ConnectionManager = _
        DtsConvert.GetExtendedInterface(package.Connections(0))
      component.RuntimeConnectionCollection(0).ConnectionManagerID = _
        package.Connections(0).ID
    End If

    ' Set the custom properties.
    instance.SetComponentProperty("AccessMode", 2)
    instance.SetComponentProperty("SqlCommand", _
      "Select * from Production.Product")

    ' Reinitialize the metadata.
    instance.AcquireConnections(vbNull)
    instance.ReinitializeMetaData()
    instance.ReleaseConnections()

    ' Add other components to the data flow and connect them.

  End Sub

End Module

Recursos externos

Entrada de blog, CreationName para SSIS 2008 e Adicionando componentes programaticamente (http://sqlis.com/sqlis/post/CreationName-2008.aspx) no sqlis.com.
Entrada de blog, EzAPI – Alternative package creation API, em blogs.msdn.com.

Fique atualizado com o Integration Services

Para obter os downloads, artigos, exemplos e vídeos da Microsoft mais recentes, bem como soluções selecionadas da comunidade, visite a página do Integration Services no MSDN:

Visite a página do Integration Services no MSDN

Para receber uma notificação automática dessas atualizações, assine os RSS feeds disponíveis na página.

Consulte também

Conceitos

Conectando componentes de fluxo de dados programaticamente

Histórico de alterações

Conteúdo atualizado
Exemplo atualizado para adicionar o componente Origem OLE DB a uma tarefa de fluxo de dados, para referenciar o provedor SQLNCLI11.1 e o valor DTSAdapter.OleDbSource.2 para ComponentClassID.

Partilhar via