2.7.1.1 pipelineObjectDataType

  • Article

The pipelineObjectDataType type is used to specify the parameters, properties, and settings that are specific to a Pipeline Task executable.

The following is the XSD for the pipelineObjectDataType type.

   <xs:complexType name="pipelineObjectDataType">
     <xs:sequence>
       <xs:sequence>
         <xs:element name="components" type="DTS:PipelineComponentsType" 
                     form="unqualified"/>
         <xs:element name="paths" type="DTS:PipelinePathsType" 
                     minOccurs="0" form="unqualified"/>
       </xs:sequence>
     </xs:sequence>
     <xs:attribute name="id" type="xs:string" form="unqualified"/>
     <xs:attribute name="name" type="xs:string" form="unqualified"/>
     <xs:attribute name="description" type="xs:string" 
                   form="unqualified"/>
     <xs:attribute name="defaultBufferMaxRows" type="xs:int" 
                   form="unqualified"/>
     <xs:attribute name="engineThreads" type="xs:int" 
                   form="unqualified"/>
     <xs:attribute name="defaultBufferSize" type="xs:int" 
                   form="unqualified"/>
     <xs:attribute name="BLOBTempStoragePath" type="xs:string" 
                   form="unqualified"/>
     <xs:attribute name="bufferTempStoragePath" type="xs:string" 
                   form="unqualified"/>
     <xs:attribute name="runInOptimizedMode" type="xs:boolean" 
                   form="unqualified"/>
   </xs:complexType>

The following table specifies the elements of the pipelineObjectDataType type.

Element

Type definition

Description

components

PipelineComponentsType

A complex type that specifies a collection of component elements. Each component element represents one node of the pipeline process.

paths

PipelinePathsType

A complex type that specifies a collection of path elements. Each path element represents one path of data flow within the pipeline process.

The following table specifies the attributes of the pipelineObjectDataType type.

Attribute

Description

id

A string value that specifies the identifier for this pipeline element. Other elements can refer to this pipeline element by using this id value.

name

A string value that specifies the name for this pipeline element.

description

A string value that specifies the description for this pipeline element.

defaultBufferMaxRows

An integer value that specifies the maximum number of rows for the default buffer.<19>

engineThreads

An integer value that specifies a suggestion to the data flow engine about the number of threads to use.<20>

defaultBufferSize

An integer value that specifies the number of bytes to allocate by default for temporary buffer storage.<21>

BLOBTempStoragePath

A string value that specifies a folder that is used for temporary storage of BLOB columns during the execution of the task.<22>

bufferTempStoragePath

A string value that specifies a folder that is used for temporary buffer storage during the execution of the task.<23>

runInOptimizedMode

A Boolean value that specifies whether to run the task in optimized mode. Optimized mode removes unused columns, outputs, and components from the data flow.

TRUE specifies that the task is run in optimized mode.

FALSE specifies that the task is not run in optimized mode.