Partager via

Classe MainPipeClass

  • Article

Adds and connects components in a data flow layout.

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly :  Microsoft.SqlServer.DTSPipelineWrap (en Microsoft.SqlServer.DTSPipelineWrap.dll)

Syntaxe

'Déclaration
<ClassInterfaceAttribute(ClassInterfaceType.None)> _
<GuidAttribute("5918251B-2970-45A4-AB5F-01C3C588FE5A")> _
Public Class MainPipeClass _
    Implements IDTSPipeline100, MainPipe, IDTSObjectModel100
'Utilisation
Dim instance As MainPipeClass

[ClassInterfaceAttribute(ClassInterfaceType.None)]
[GuidAttribute("5918251B-2970-45A4-AB5F-01C3C588FE5A")]
public class MainPipeClass : IDTSPipeline100, 
    MainPipe, IDTSObjectModel100

[ClassInterfaceAttribute(ClassInterfaceType::None)]
[GuidAttribute(L"5918251B-2970-45A4-AB5F-01C3C588FE5A")]
public ref class MainPipeClass : IDTSPipeline100, 
    MainPipe, IDTSObjectModel100

[<ClassInterfaceAttribute(ClassInterfaceType.None)>]
[<GuidAttribute("5918251B-2970-45A4-AB5F-01C3C588FE5A")>]
type MainPipeClass =  
    class 
        interface IDTSPipeline100 
        interface MainPipe 
        interface IDTSObjectModel100 
    end

public class MainPipeClass implements IDTSPipeline100, MainPipe, IDTSObjectModel100

Le type MainPipeClass expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique MainPipeClass Initializes a new instance of the MainPipeClass.

Haut de la page

Propriétés

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

Haut de la page

Méthodes

  Nom Description
Méthode publique Equals (hérité de Object.)
Méthode protégée Finalize (hérité de Object.)
Méthode publique GetHashCode (hérité de Object.)
Méthode publique GetNextPasteID Gets the next available ID that a data flow task generates.
Méthode publique GetObjectByID Retrieves an object contained in a data flow task.
Méthode publique GetType (hérité de Object.)
Méthode publique IDTSObjectModel100_GetObjectByID Retrieves an object that is contained in a data flow task.
Méthode publique IDTSObjectModel100_New Resets the layout of components in a data flow task.
Méthode publique IDTSObjectModel100_UpdateCacheOnInputColumns Sets the data flow task to update the cache from previous version.
Méthode protégée MemberwiseClone (hérité de Object.)
Méthode publique New Infrastructure. Creates a new instance of MainPipeClass.
Méthode publique ToString (hérité de Object.)
Méthode publique UpdateCacheOnInputColumns Sets the cache to upgrade from previous version.

Haut de la page

Notes

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.

Exemples

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

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Voir aussi

Référence

Espace de noms Microsoft.SqlServer.Dts.Pipeline.Wrapper