Condividi tramite

Classe PipelineComponent

  • Articolo

Defines the base class that is used when developing managed data flow components.

Gerarchia di ereditarietà

System.Object
  Microsoft.SqlServer.Dts.Pipeline.PipelineComponent
    Microsoft.SqlServer.Dts.Pipeline.ScriptComponentHost

Spazio dei nomi  Microsoft.SqlServer.Dts.Pipeline
Assembly:  Microsoft.SqlServer.PipelineHost (in Microsoft.SqlServer.PipelineHost.dll)

Sintassi

'Dichiarazione
Public Class PipelineComponent
'Utilizzo
Dim instance As PipelineComponent

public class PipelineComponent

public ref class PipelineComponent

type PipelineComponent =  class end

public class PipelineComponent

Nel tipo PipelineComponent sono esposti i membri seguenti.

Costruttori

  Nome Descrizione
Metodo pubblico PipelineComponent Initializes a new instance of the PipelineComponent class.

In alto

Proprietà

  Nome Descrizione
Proprietà pubblica BufferManager Gets the IDTSBufferManager100 of the pipeline component.
Proprietà pubblica ComponentMetaData Gets the IDTSComponentMetaData100 for a component.
Proprietà pubblica ErrorSupport Returns an ErrorSupport object that lets the component raise errors, warnings, or other information events based on HRESULTs returned by Integration Services components written in native code.
Proprietà pubblica EventInfos Gets the IDTSEventInfos100 collection of the PipelineComponent object.
Proprietà pubblica LogEntryInfos Gets an IDTSLogEntryInfos100 collection of logging events that the component has registered.
Proprietà pubblica ReferenceTracker Gets the IDTSObjectReferenceTracker100 associated with the component.
Proprietà pubblica VariableDispenser Gets the IDTSVariableDispenser100 of the data flow component.

In alto

Metodi

  Nome Descrizione
Metodo pubblico AcquireConnections Establishes a connection to a connection manager.
Metodo pubblico AddErrorOutput Adds an IDTSOutput100 object and marks it as an error output by setting the IsErrorOut property to true.
Metodo protettoMembro statico BufferTypeToDataRecordType Returns a managed data type based on an Integration Services data type.
Metodo pubblico Cleanup Frees resources and finishes the execution of the component.
Metodo protettoMembro statico ConvertBufferDataTypeToFitManaged Gets the appropriate Integration Services DataType from managed code.
Metodo protettoMembro statico DataRecordTypeToBufferType Gets the Integration Services DataType that corresponds to a managed type.
Metodo pubblico DeleteExternalMetadataColumn Deletes the external metadata column at the specified index from the collection of external metadata columns.
Metodo pubblico DeleteInput Deletes an IDTSInput100 object from the IDTSInputCollection100 collection.
Metodo pubblico DeleteOutput Deletes an IDTSOutput100 object from the IDTSOutputCollection100 collection.
Metodo pubblico DeleteOutputColumn Deletes an IDTSOutputColumn100 object from the IDTSOutputColumnCollection100 collection.
Metodo pubblico DescribeRedirectedErrorCode Provides error code information for a PipelineBuffer row added to an output buffer.
Metodo pubblico Equals Ereditato da Object.
Metodo protetto Finalize Ereditato da Object.
Metodo pubblico GetDependentInputs Returns a collection of the input IDs of inputs that are waiting for more data, and thus are blocking the specified input.
Metodo pubblico GetErrorOutputInfo Returns the index and ID of the error output of the component.
Metodo pubblico GetHashCode Ereditato da Object.
Metodo pubblico GetType Ereditato da Object.
Metodo protettoMembro statico idxOfBufferType Infrastruttura. Specifies the type of the buffer index.
Metodo protettoMembro statico idxOfDataRecordType Infrastruttura. Specifies the type of the data record index.
Metodo pubblico Initialize When overridden in a derived class, initializes a new instance of a custom data flow component.
Metodo pubblico InsertExternalMetadataColumnAt Inserts a new external metadata column into the collection of external metadata columns at the specified index.
Metodo pubblico InsertInput Adds an IDTSInput100 object to the IDTSInputCollection100.
Metodo pubblico InsertOutput Adds a new IDTSOutput100 object
Metodo pubblico InsertOutputColumnAt Creates a new IDTSOutputColumn100 object and inserts it into the IDTSOutputColumnCollection100.
Metodo protettoMembro statico IsCompatibleNumericTypes Determines whether two numeric data types are compatible to support a conversion from one type to the other.
Metodo pubblico IsInputReady Determines which of the inputs attached to a component are waiting for more data, and which have enough data to process and are blocked.
Metodo pubblico MapInputColumn Establishes a relationship between an input column and a corresponding external metadata column.
Metodo pubblico MapOutputColumn Establishes a relationship between an output column and a corresponding external metadata column.
Metodo protetto MemberwiseClone Ereditato da Object.
Metodo pubblico OnDeletingInputColumn Deletes an IDTSInputColumn100 object from the IDTSInputColumnCollection100.
Metodo pubblico OnInputPathAttached Called when an IDTSInput100 object is connected to the component through the IDTSPath100 interface.
Metodo pubblico OnInputPathDetached Called when an IDTSInput100 object is disconnected from the component through the IDTSPath100 interface.
Metodo pubblico OnOutputPathAttached Called when an IDTSOutput100 object of the component is attached to a downstream component.
Metodo pubblico PerformUpgrade Upgrades the component metadata to the version of the component installed on the local computer.
Metodo pubblico PostExecute Called at the end of component execution, but before Cleanup.
Metodo pubblico PreExecute Called after PrepareForExecute, and before PrimeOutput and ProcessInput.
Metodo pubblico PrepareForExecute Called before PreExecute.
Metodo pubblico PrimeOutput Called at run time for source components and transformation components with asynchronous outputs to let these components add rows to the output buffers.
Metodo pubblico ProcessInput Called at run time when a PipelineBuffer from an upstream component is available to the component to let the component process the incoming rows.
Metodo pubblico ProvideComponentProperties Called when a component is first added to the data flow task, to initialize the ComponentMetaData of the component.
Metodo pubblico RegisterEvents When you are developing a custom data flow component, you override this method to create custom events.
Metodo pubblico RegisterLogEntries Registers the events that the component will log.
Metodo pubblico ReinitializeMetaData Repairs any errors identified during validation that cause the component to return VS_NEEDSNEWMETADATA at design time.
Metodo pubblico ReleaseConnections Frees the connections established during AcquireConnections. Called at design time and run time.
Metodo pubblico RemoveAllInputsOutputsAndCustomProperties Deletes each IDTSInput100 and IDTSOutput100 object from the component.
Metodo pubblico SetComponentProperty Assigns a value to a IDTSCustomProperty100 of the component.
Metodo pubblico SetExternalMetadataColumnDataTypeProperties Sets the data type properties of the specified external metadata column.
Metodo pubblico SetExternalMetadataColumnProperty Sets an individual property of an external metadata column.
Metodo pubblico SetInputColumnProperty Assigns a value to the IDTSCustomProperty100 of an IDTSInputColumn100 object.
Metodo pubblico SetInputProperty Assigns a value to the IDTSCustomProperty100 of an IDTSInput100 object.
Metodo pubblico SetOutputColumnDataTypeProperties Sets the data type properties of an IDTSOutputColumn100 object.
Metodo pubblico SetOutputColumnProperty Sets the value of an IDTSCustomProperty100 for an IDTSOutputColumn100 object.
Metodo pubblico SetOutputProperty Sets the value of an IDTSCustomProperty100 on an IDTSOutput100 object.
Metodo pubblico SetUsageType Creates an IDTSInputColumn100 object in the IDTSInputColumnCollection100 of the component and sets the UsageType property of the column.
Metodo pubblico ToString Ereditato da Object.
Metodo pubblico Validate Verifies that the component is correctly configured.

In alto

Campi

  Nome Descrizione
Campo pubblicoMembro statico s_STOCKPROPNAME_COMPFLAGS Contains the name of the ComparisonFlags property of data flow components.
Campo pubblicoMembro statico s_STOCKPROPNAME_DELOUTPUTONPATHDETACHED Contains the name of the DeleteOutputOnPathDetached property of data flow components.
Campo pubblicoMembro statico s_STOCKPROPNAME_EXCLGROUP Contains the name of the ExclusionGroup property of data flow components.
Campo pubblicoMembro statico s_STOCKPROPNAME_HASSIDEEFFECTS Contains the name of the HasSideEffects property of data flow components.
Campo pubblicoMembro statico s_STOCKPROPNAME_ISDISTRIBUTABLE Contains the name of the IsDistributable property of data flow components.
Campo pubblicoMembro statico s_STOCKPROPNAME_ISERROROUT Contains the name of the IsErrorOut property of data flow components.
Campo pubblicoMembro statico s_STOCKPROPNAME_ISSORTED Contains the name of the IsSorted property of data flow components.
Campo pubblicoMembro statico s_STOCKPROPNAME_REFMETADATAID Contains the name of the ReferenceMetaDataID property of data flow components.
Campo pubblicoMembro statico s_STOCKPROPNAME_SORTKEYPOS Contains the name of the SortKeyPosition property of data flow components.
Campo pubblicoMembro statico s_STOCKPROPNAME_SYNCINPUTID Contains the name of the SynchronousInputID property of data flow components.

In alto

Osservazioni

Inherit from this class to create your own data flow component. This class implements the required component interfaces, IDTSDesigntimeComponent100 and IDTSRuntimeComponent100. You override the base class implementation of these methods to provide the functionality of your component. PipelineComponent provides helper methods in addition to the methods of the component interfaces to help you in developing your component.

Esempi

The following code example shows a component that implements the DtsPipelineComponentAttribute and inherits from the PipelineComponent class.

using System;
using Microsoft.SqlServer.Dts.Pipeline.Wrapper;
namespace Microsoft.Samples.SqlServer.Dts
{
    [DtsPipelineComponent(DisplayName="SampleComponent")]
    public class SampleComponent : PipelineComponent
    {
        public override ProvideComponentProperties()
        {
            // TODO: Implement component intialization.
        }
        public override DTSValidationStatus Validate()
        {
            // TODO: Implement component validation.
        }
        public override void ProcessInput( int inputID, PipelineBuffer buffer)
        {
            // TODO: For transformation and destination components,
            //  implement code to process incoming rows.
        }
    }
}

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

 <DtsPipelineComponent(DisplayName="SampleComponent")> _ 
 Public Class SampleComponent 
 Inherits PipelineComponent 

   Public Overrides Sub ProvideComponentProperties() 
    ' TODO: Implement component intialization.
   End Sub 

   Public Overrides Function Validate() As DTSValidationStatus 
    ' TODO: Implement component validation.
   End Function 

   Public Overrides Sub ProcessInput(ByVal inputID As Integer, ByVal buffer As PipelineBuffer) 
    ' TODO: For transformation and destination components,
    '  implement code to process incoming rows.
   End Sub 
 End Class 
End Namespace

Protezione dei thread

I membri static (Shared in Visual Basic) pubblici di questo tipo sono affidabili. Non è invece garantita la sicurezza dei membri dell'istanza.

Vedere anche

Riferimento

Spazio dei nomi Microsoft.SqlServer.Dts.Pipeline