MainPipeClass Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Pipeline.Wrapper

Assembly:

Microsoft.SqlServer.DTSPipelineWrap.dll

Adds and connects components in a data flow layout.

public ref class MainPipeClass : Microsoft::SqlServer::Dts::Pipeline::Wrapper::IDTSPipeline130, Microsoft::SqlServer::Dts::Pipeline::Wrapper::MainPipe

[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)]
[System.Runtime.InteropServices.Guid("D9DA2996-AD06-4166-9C0C-C53E29834AF2")]
public class MainPipeClass : Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSPipeline130, Microsoft.SqlServer.Dts.Pipeline.Wrapper.MainPipe

[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)>]
[<System.Runtime.InteropServices.Guid("D9DA2996-AD06-4166-9C0C-C53E29834AF2")>]
type MainPipeClass = class
    interface IDTSPipeline100
    interface MainPipe
    interface IDTSObjectModel100
    interface IDTSPipeline130

Public Class MainPipeClass
Implements IDTSPipeline130, MainPipe

Inheritance

Object

MainPipeClass

Attributes

ClassInterfaceAttribute GuidAttribute TypeLibTypeAttribute

Implements

IDTSObjectModel100 IDTSPipeline100 IDTSPipeline130 MainPipe

Examples

The following code example adds a data flow task to a package, adds an OLE DB source component and an OLE DB destination component, and establishes a path between the two components.

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

namespace Microsoft.Samples.SqlServer.Dts  
{  
    public class Class1  
    {  
        public static void Main(string []args)  
        {  
            // Create the package.  
            Package p = new Package();  

            // Add the data flow task.  
            MainPipe mp = ((TaskHost)p.Executables.Add("DTS.Pipeline")).InnerObject as MainPipe;  

            // Add the OLE DB source component.  
            IDTSComponentMetaData100 mdOleDbSrc = mp.ComponentMetaDataCollection.New();  
            mdOleDbSrc.ComponentClassID = "DTSAdapter.OleDbSource";  
            mdOleDbSrc.Name = "OLEDB Source";  
            CManagedComponentWrapper wrpOledbSrc = mdOleDbSrc.Instantiate();  

            // Add the OLE DB destination component.  
            IDTSComponentMetaData100 mdOleDbDest = mp.ComponentMetaDataCollection.New();  
            mdOleDbDest.ComponentClassID = "DTSAdapter.OleDbDestination";  
            mdOleDbDest.Name = "OLEDB Destination";  
            CManagedComponentWrapper wrpOledbDest = mdOleDbSrc.Instantiate();  

            // Create a path and attach the output of the source to the input of the destination.  
            IDTSPath100 path = mp.PathCollection.New();  
            path.AttachPathAndPropagateNotifications(mdOleDbSrc.OutputCollection[0], mdOleDbDest.InputCollection[0]);  
        }  
    }  
}  

Imports System   
Imports Microsoft.SqlServer.Dts.Runtime   
Imports Microsoft.SqlServer.Dts.Pipeline.Wrapper   
Namespace Microsoft.Samples.SqlServer.Dts   

 Public Class Class1   

   Public Shared Sub Main(ByVal args As String())   
     Dim p As Package = New Package   
     Dim mp As MainPipe = CType(CType(p.Executables.Add("DTS.Pipeline"), TaskHost).InnerObject, MainPipe)   
     Dim mdOleDbSrc As IDTSComponentMetaData100 = mp.ComponentMetaDataCollection.New   
     mdOleDbSrc.ComponentClassID = "DTSAdapter.OleDbSource"   
     mdOleDbSrc.Name = "OLEDB Source"   
     Dim wrpOledbSrc As CManagedComponentWrapper = mdOleDbSrc.Instantiate   
     Dim mdOleDbDest As IDTSComponentMetaData100 = mp.ComponentMetaDataCollection.New   
     mdOleDbDest.ComponentClassID = "DTSAdapter.OleDbDestination"   
     mdOleDbDest.Name = "OLEDB Destination"   
     Dim wrpOledbDest As CManagedComponentWrapper = mdOleDbSrc.Instantiate   
     Dim path As IDTSPath100 = mp.PathCollection.New   
     path.AttachPathAndPropagateNotifications(mdOleDbSrc.OutputCollection(0), mdOleDbDest.InputCollection(0))   
   End Sub   
 End Class   
End Namespace  

Remarks

This class represents the data flow task, and is used when programmatically building a data flow layout. An instance of the class is created by adding the data flow task to the Executables collection of a Package. Components are added to the task using the ComponentMetaDataCollection property. Connections are established between components using the PathCollection property.

Constructors

MainPipeClass()

Initializes a new instance of the MainPipeClass.

Properties

AutoAdjustBufferSize	Automatically sets the size of buffers in the data flow.
AutoGenerateIDForNewObjects	Gets or sets a value that specifies whether a data flow automatically generates and sets the ID property for newly created objects.
BLOBTempStoragePath	Gets or sets a value that specifies the file system location where binary large objects (BLOBs) are temporarily written to disk.
BufferManager	Gets the buffer manager for the main pipe.
BufferTempStoragePath	Gets or sets the file system path used to temporarily cache buffer data.
ComponentMetaDataCollection	Gets the collection of data flow components in the task.
DefaultBufferMaxRows	Gets or sets the maximum number of rows the task allows in an IDTSBuffer100 buffer.
DefaultBufferSize	Gets or sets the default size of the IDTSBuffer100 objects created by a task.
EnableCacheUpdate	Gets or sets a value that indicates whether the data flow task enables cache updates.
EnableDisconnectedColumns	Gets or sets a value that indicates whether the task enables disconnected columns.
EngineThreads	Gets or sets the number of threads a data flow task uses.
Events	Sets the events interface that a data flow, and the components it contains, use to raise events during execution.
IDTSObjectModel100_AutoGenerateIDForNewObjects	Gets or sets a value that specifies whether a data flow automatically generates and sets the ID property for newly created objects.
IDTSObjectModel100_ComponentMetaDataCollection	Gets the collection of data flow components in the task.
IDTSObjectModel100_EnableCacheUpdate	Gets or sets a value that indicates whether the data flow task enables the cache updates.
IDTSObjectModel100_EnableDisconnectedColumns	Gets or sets a value that indicates whether the data flow task enables the disconnected columns in the main pipe.
IDTSObjectModel100_IsSavingXml	Gets or sets a value that indicates the data flow task saves in Xml format.
IDTSObjectModel100_PathCollection	Gets the IDTSPathCollection100 collection for a data flow task.
IDTSPipeline130_AutoGenerateIDForNewObjects
IDTSPipeline130_BLOBTempStoragePath
IDTSPipeline130_BufferManager
IDTSPipeline130_BufferTempStoragePath
IDTSPipeline130_ComponentMetaDataCollection
IDTSPipeline130_DefaultBufferMaxRows
IDTSPipeline130_DefaultBufferSize
IDTSPipeline130_EnableCacheUpdate
IDTSPipeline130_EnableDisconnectedColumns
IDTSPipeline130_EngineThreads
IDTSPipeline130_Events
IDTSPipeline130_IsSavingXml
IDTSPipeline130_PathCollection
IDTSPipeline130_PersistenceCustomPropertyCollection[DTSPersistenceFormat]
IDTSPipeline130_RunInOptimizedMode
IDTSPipeline130_VariableDispenser
IsSavingXml	Gets or sets a value that indicates whether the task saves in Xml format.
PathCollection	Gets the IDTSPathCollection100 collection for a data flow task.
PersistenceCustomPropertyCollection[DTSPersistenceFormat]	Gets the persistence format of the data flow task's custom property collection.
RunInOptimizedMode	Gets or sets a value that specifies whether a data flow task runs in optimized mode.
VariableDispenser	Sets the IDTSVariableDispenser100 used to lock variables in a package for reading and writing.

Methods

GetNextPasteID()	Gets the next available ID that a data flow task generates.
GetObjectByID(Int32)	Retrieves an object contained in a data flow task.
IDTSObjectModel100_get_AutoGenerateIDForNewObjects()
IDTSObjectModel100_get_ComponentMetaDataCollection()
IDTSObjectModel100_get_EnableCacheUpdate()
IDTSObjectModel100_get_EnableDisconnectedColumns()
IDTSObjectModel100_get_IsSavingXml()
IDTSObjectModel100_get_PathCollection()
IDTSObjectModel100_GetObjectByID(Int32)	Retrieves an object that is contained in a data flow task.
IDTSObjectModel100_New()	Resets the layout of components in a data flow task.
IDTSObjectModel100_set_AutoGenerateIDForNewObjects(Boolean)
IDTSObjectModel100_set_EnableCacheUpdate(Boolean)
IDTSObjectModel100_set_EnableDisconnectedColumns(Boolean)
IDTSObjectModel100_set_IsSavingXml(Boolean)
IDTSObjectModel100_UpdateCacheOnInputColumns()	Sets the data flow task to update the cache from previous version.
IDTSPipeline130_get_AutoGenerateIDForNewObjects()
IDTSPipeline130_get_BLOBTempStoragePath()
IDTSPipeline130_get_BufferManager()
IDTSPipeline130_get_BufferTempStoragePath()
IDTSPipeline130_get_ComponentMetaDataCollection()
IDTSPipeline130_get_DefaultBufferMaxRows()
IDTSPipeline130_get_DefaultBufferSize()
IDTSPipeline130_get_EnableCacheUpdate()
IDTSPipeline130_get_EnableDisconnectedColumns()
IDTSPipeline130_get_EngineThreads()
IDTSPipeline130_get_IsSavingXml()
IDTSPipeline130_get_PathCollection()
IDTSPipeline130_get_PersistenceCustomPropertyCollection(DTSPersistenceFormat)
IDTSPipeline130_get_RunInOptimizedMode()
IDTSPipeline130_GetNextPasteID()
IDTSPipeline130_GetObjectByID(Int32)
IDTSPipeline130_New()
IDTSPipeline130_set_AutoGenerateIDForNewObjects(Boolean)
IDTSPipeline130_set_BLOBTempStoragePath(String)
IDTSPipeline130_set_BufferTempStoragePath(String)
IDTSPipeline130_set_DefaultBufferMaxRows(Int32)
IDTSPipeline130_set_DefaultBufferSize(Int32)
IDTSPipeline130_set_EnableCacheUpdate(Boolean)
IDTSPipeline130_set_EnableDisconnectedColumns(Boolean)
IDTSPipeline130_set_EngineThreads(Int32)
IDTSPipeline130_set_Events(IDTSComponentEvents100)
IDTSPipeline130_set_IsSavingXml(Boolean)
IDTSPipeline130_set_RunInOptimizedMode(Boolean)
IDTSPipeline130_set_VariableDispenser(IDTSVariableDispenser100)
IDTSPipeline130_UpdateCacheOnInputColumns()
New()	Creates a new instance of MainPipeClass.
UpdateCacheOnInputColumns()	Sets the cache to upgrade from previous version.