TechNet
Export (0) Print
Expand All

MainPipeClass Class

 

Adds and connects components in a data flow layout.

Namespace:   Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly:  Microsoft.SqlServer.DTSPipelineWrap (in Microsoft.SqlServer.DTSPipelineWrap.dll)

System.Object
  Microsoft.SqlServer.Dts.Pipeline.Wrapper.MainPipeClass

[ClassInterfaceAttribute(ClassInterfaceType.None)]
[GuidAttribute("C4D4D1F8-B3EF-4A16-9E0B-BD837F067CAA")]
[TypeLibTypeAttribute(TypeLibTypeFlags.FCanCreate)]
public class MainPipeClass : IDTSPipeline100, MainPipe, IDTSObjectModel100, 
	IDTSPipeline130

NameDescription
System_CAPS_pubmethodMainPipeClass()

Initializes a new instance of the MainPipeClass.

NameDescription
System_CAPS_pubpropertyAutoAdjustBufferSize

Automatically sets the size of buffers in the data flow.

System_CAPS_pubpropertyAutoGenerateIDForNewObjects

Gets or sets a value that specifies whether a data flow automatically generates and sets the ID property for newly created objects.

System_CAPS_pubpropertyBLOBTempStoragePath

Gets or sets a value that specifies the file system location where binary large objects (BLOBs) are temporarily written to disk.

System_CAPS_pubpropertyBufferManager

Gets the buffer manager for the main pipe.

System_CAPS_pubpropertyBufferTempStoragePath

Gets or sets the file system path used to temporarily cache buffer data.

System_CAPS_pubpropertyComponentMetaDataCollection

Gets the collection of data flow components in the task.

System_CAPS_pubpropertyDefaultBufferMaxRows

Gets or sets the maximum number of rows the task allows in an IDTSBuffer100 buffer.

System_CAPS_pubpropertyDefaultBufferSize

Gets or sets the default size of the IDTSBuffer100 objects created by a task.

System_CAPS_pubpropertyEnableCacheUpdate

Gets or sets a value that indicates whether the data flow task enables cache updates.

System_CAPS_pubpropertyEnableDisconnectedColumns

Gets or sets a value that indicates whether the task enables disconnected columns.

System_CAPS_pubpropertyEngineThreads

Gets or sets the number of threads a data flow task uses.

System_CAPS_pubpropertyEvents

Sets the events interface that a data flow, and the components it contains, use to raise events during execution.

System_CAPS_pubpropertyIDTSObjectModel100_AutoGenerateIDForNewObjects

Gets or sets a value that specifies whether a data flow automatically generates and sets the ID property for newly created objects.

System_CAPS_pubpropertyIDTSObjectModel100_ComponentMetaDataCollection

Gets the collection of data flow components in the task.

System_CAPS_pubpropertyIDTSObjectModel100_EnableCacheUpdate

Gets or sets a value that indicates whether the data flow task enables the cache updates.

System_CAPS_pubpropertyIDTSObjectModel100_EnableDisconnectedColumns

Gets or sets a value that indicates whether the data flow task enables the disconnected columns in the main pipe.

System_CAPS_pubpropertyIDTSObjectModel100_IsSavingXml

Gets or sets a value that indicates the data flow task saves in Xml format.

System_CAPS_pubpropertyIDTSObjectModel100_PathCollection

Gets the IDTSPathCollection100 collection for a data flow task.

System_CAPS_pubpropertyIDTSPipeline130_AutoGenerateIDForNewObjects

System_CAPS_pubpropertyIDTSPipeline130_BLOBTempStoragePath

System_CAPS_pubpropertyIDTSPipeline130_BufferManager

System_CAPS_pubpropertyIDTSPipeline130_BufferTempStoragePath

System_CAPS_pubpropertyIDTSPipeline130_ComponentMetaDataCollection

System_CAPS_pubpropertyIDTSPipeline130_DefaultBufferMaxRows

System_CAPS_pubpropertyIDTSPipeline130_DefaultBufferSize

System_CAPS_pubpropertyIDTSPipeline130_EnableCacheUpdate

System_CAPS_pubpropertyIDTSPipeline130_EnableDisconnectedColumns

System_CAPS_pubpropertyIDTSPipeline130_EngineThreads

System_CAPS_pubpropertyIDTSPipeline130_Events

System_CAPS_pubpropertyIDTSPipeline130_IsSavingXml

System_CAPS_pubpropertyIDTSPipeline130_PathCollection

System_CAPS_pubpropertyIDTSPipeline130_PersistenceCustomPropertyCollection[DTSPersistenceFormat]

System_CAPS_pubpropertyIDTSPipeline130_RunInOptimizedMode

System_CAPS_pubpropertyIDTSPipeline130_VariableDispenser

System_CAPS_pubpropertyIsSavingXml

Gets or sets a value that indicates whether the task saves in Xml format.

System_CAPS_pubpropertyPathCollection

Gets the IDTSPathCollection100 collection for a data flow task.

System_CAPS_pubpropertyPersistenceCustomPropertyCollection[DTSPersistenceFormat]

Gets the persistence format of the data flow task's custom property collection.

System_CAPS_pubpropertyRunInOptimizedMode

Gets or sets a value that specifies whether a data flow task runs in optimized mode.

System_CAPS_pubpropertyVariableDispenser

Sets the IDTSVariableDispenser100 used to lock variables in a package for reading and writing.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetNextPasteID()

Gets the next available ID that a data flow task generates.

System_CAPS_pubmethodGetObjectByID(Int32)

Retrieves an object contained in a data flow task.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodIDTSObjectModel100_GetObjectByID(Int32)

Retrieves an object that is contained in a data flow task.

System_CAPS_pubmethodIDTSObjectModel100_New()

Resets the layout of components in a data flow task.

System_CAPS_pubmethodIDTSObjectModel100_UpdateCacheOnInputColumns()

Sets the data flow task to update the cache from previous version.

System_CAPS_pubmethodIDTSPipeline130_GetNextPasteID()

System_CAPS_pubmethodIDTSPipeline130_GetObjectByID(Int32)

System_CAPS_pubmethodIDTSPipeline130_New()

System_CAPS_pubmethodIDTSPipeline130_UpdateCacheOnInputColumns()

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodNew()

This API supports the product infrastructure and is not intended to be used directly from your code. Creates a new instance of MainPipeClass.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdateCacheOnInputColumns()

Sets the cache to upgrade from previous version.

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.

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]);
        }
    }
}

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft