• Article

PipelineBuffer Class

Provides an in-memory data store containing rows and columns of data.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Pipeline.PipelineBuffer

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

Syntax

'Declaration
Public Class PipelineBuffer _
    Implements IDisposable
'Usage
Dim instance As PipelineBuffer

public class PipelineBuffer : IDisposable

public ref class PipelineBuffer : IDisposable

type PipelineBuffer =  
    class
        interface IDisposable
    end

public class PipelineBuffer implements IDisposable

The PipelineBuffer type exposes the following members.

Constructors

  Name Description
Protected method PipelineBuffer Instantiates a new instance of the PipelineBuffer.

Top

Properties

  Name Description
Public property ColumnCount Gets the number of columns in the PipelineBuffer.
Public property CurrentRow Gets the index of the current row in the PipelineBuffer.
Public property EndOfRowset Gets a value indicating whether the current PipelineBuffer is the final buffer.
Public property Item Gets the data stored in a buffer column.
Public property Mode Gets a value indicating whether a PipelineBuffer is an IDTSInput100 buffer or an IDTSOutput100 buffer.
Public property RowCount Gets the number of rows in the PipelineBuffer object.

Top

Methods

  Name Description
Public method AddBlobData(Int32, array<Byte[]) Adds an array of bytes to a PipelineBuffer column.
Public method AddBlobData(Int32, array<Byte[], Int32) Adds an array of a specified number of bytes to a PipelineBuffer column.
Public method AddRow Adds a row to the PipelineBuffer object.
Public method DirectErrorRow(Int32, Int32, Int32) Sends a PipelineBuffer row to an IDTSOutput100 whose IsErrorOut property is true.
Public method DirectErrorRow(Int32, Int32, Int32, Int32) Sends a PipelineBuffer row to an IDTSOutput100 whose IsErrorOut property is true.
Public method DirectRow Sends a row from a PipelineBuffer to the specified IDTSOutput100.
Public method Dispose() Releases all resources used by the PipelineBuffer.
Protected method Dispose(Boolean) Releases the unmanaged resources that are used by the PipelineBuffer, and optionally releases the managed resources.
Public method Equals (Inherited from Object.)
Protected method Finalize Releases all resources used by the PipelineBuffer. (Overrides Object.Finalize().)
Public method GetBlobData Retrieves an array of bytes from a binary large object (BLOB) stored in a PipelineBuffer column.
Public method GetBlobLength Gets the number of bytes contained in a binary large object (BLOB) PipelineBuffer column.
Public method GetBoolean Gets the bool value stored in the PipelineBuffer column.
Public method GetByte Gets the byte value stored in the PipelineBuffer column.
Public method GetBytes Gets the array of bytes stored in a buffer column.
Public method GetColumnInfo Retrieves the BufferColumn structure for a PipelineBuffer column.
Public method GetDate Gets the DateTime value stored in the PipelineBuffer column.
Public method GetDateTime Gets the DateTime value stored in the PipelineBuffer column.
Public method GetDateTimeOffset Gets the DateTimeOffset value stored in the PipelineBuffer column.
Public method GetDecimal Gets the decimal value stored in the PipelineBuffer column.
Public method GetDouble Gets the double stored in the PipelineBuffer column.
Public method GetGuid Gets the Guid value stored in the PipelineBuffer column.
Public method GetHashCode (Inherited from Object.)
Public method GetInt16 Gets the short stored in the PipelineBuffer column.
Public method GetInt32 Gets the int stored in a PipelineBuffer column.
Public method GetInt64 Gets the long stored in the PipelineBuffer column.
Public method GetSByte Gets the SByte value stored in a PipelineBuffer column.
Public method GetSingle Gets the float stored in a PipelineBuffer column.
Public method GetString Gets the string stored in the buffer column.
Public method GetTime Gets the TimeSpan value stored in the PipelineBuffer column.
Public method GetType (Inherited from Object.)
Public method GetUInt16 Gets the ushort value stored in the buffer column.
Public method GetUInt32 Gets the UInt32 value stored in the buffer column.
Public method GetUInt64 Gets the ulong value stored in the buffer column.
Public method IsNull Checks to see if the data in a buffer column is null.
Protected method MemberwiseClone (Inherited from Object.)
Public method NextRow Advances the PipelineBuffer to the next row.
Public method RemoveRow Removes the current row from the PipelineBuffer.
Public method ResetBlobData Deletes the contents of the specified BLOB column.
Public method SetBoolean Assigns a bool value to a PipelineBuffer column.
Public method SetByte Assigns a byte to a PipelineBuffer column.
Public method SetBytes Assigns an array of bytes to a buffer column.
Public method SetDate Assigns a DateTime value to the PipelineBuffer column.
Public method SetDateTime Assigns a DateTime value to the PipelineBuffer column.
Public method SetDateTimeOffset Assigns a DateTimeOffset value to the PipelineBuffer column.
Public method SetDecimal Assigns a decimal to a buffer column.
Public method SetDouble Assigns a double to a PipelineBuffer column.
Public method SetEndOfRowset Notifies the PipelineBuffer that a component has finished adding rows to the buffer.
Public method SetErrorInfo Sets the error information for the current PipelineBuffer row.
Public method SetGuid Assigns a Guid to a buffer column.
Public method SetInt16 Assigns a 16-bit signed integer to a buffer column.
Public method SetInt32 Assigns a 32-bit signed integer to a buffer column.
Public method SetInt64 Assigns a 64-bit signed integer to a buffer column.
Public method SetNull Assigns nulla null reference (Nothing in Visual Basic) to a buffer column.
Public method SetSByte Assigns a signed 8-bit integer to a buffer column.
Public method SetSingle Assigns a float to a buffer column.
Public method SetString Assigns a string to a buffer column.
Public method SetTime Assigns a TimeSpan value to the PipelineBuffer column.
Public method SetUInt16 Assigns an unsigned 16-bit integer to a buffer column.
Public method SetUInt32 Assigns an unsigned 32-bit integer to a buffer column.
Public method SetUInt64 Assigns an unsigned 64-bit integer to a buffer column.
Public method ToString (Inherited from Object.)

Top

Remarks

The PipelineBuffer is an in-memory two-dimensional data store containing rows and columns. It is created by the data flow task and supplied to managed data flow components during execution. The columns contained in a buffer are based on the columns in the IDTSOutputColumnCollection100 collections of the components in the graph.

Source components and components with asynchronous outputs receive a buffer for each of the output objects that are connected to a downstream component. These buffers are referred to as output buffers and do not contain rows. The component that receives the output buffer adds rows to the buffer and calls the SetEndOfRowset method when finished. This method sets the value of the EndOfRowset property to true on the final buffer. The data flow task then provides that buffer to the next component in the graph.

Transformation components with synchronous outputs and destination components receive PipelineBuffer objects in the ProcessInput method. The PipelineBuffer received in this method is an Input buffer and contains the rows that were added to by upstream components. This buffer is restricted and cannot be used to add or remove rows from the buffer.

The PipelineBuffer is written in managed code and supports managed data flow component developers by marshalling data between managed code and the underlying IDTSBuffer100 COM object.

For a complete list of Integration Services data types and the corresponding Get and Set methods of the PipelineBuffer class to use with each data type, see Working with Data Types in the Data Flow.

Examples

The following example shows a transformation component that iterates the rows and columns of a PipelineBuffer in ProcessInput.

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


namespace Microsoft.Samples.SqlServer.Dts
{
   [DtsPipelineComponent
   (
   DisplayName="SampleComponent",
   ComponentType=ComponentType.Transform
   )]
   public class SampleComponent: PipelineComponent
   {
      public override void ProvideComponentProperties()
      {
         base.ProvideComponentProperties();

         ///Name the input and output add by the base class.
         ComponentMetaData.InputCollection[0].Name = "SampleInput";
         ComponentMetaData.OutputCollection[0].Name = "SampleOutput";
      }

      public override void ProcessInput(int inputID, PipelineBuffer buffer)
      {

      IDTSInput100 input = ComponentMetaData.InputCollection.GetObjectByID(inputID);

      while (buffer.NextRow())
      {
         foreach (IDTSInputColumn100 col in input.InputColumnCollection)
         {
            int colIndex = BufferManager.FindColumnByLineageID(input.Buffer,col.LineageID);
            object colData = buffer[colIndex];
            //TODO: Do something with the column data.
         }
      }
      }
   }
}

The following example shows a source component that adds rows to the output buffer in PrimeOutput.

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


namespace Microsoft.Samples.SqlServer.Dts
{
   [DtsPipelineComponent
   (
      DisplayName="SampleComponent",
      ComponentType=ComponentType.SourceComponent
)]
   public class SampleComponent: PipelineComponent
   {
      public override void PrimeOutput(int outputs, int[] outputIDs,PipelineBuffer[] buffers)
      {
         int rows = 100;
         PipelineBuffer buf = buffers[0];
         IDTSOutput100 output = ComponentMetaData.OutputCollection[0];
         Random rand = new Random();

         //Loop rows number of times
         for(int r = 0; r < rows; r++)
         {
            buf.AddRow();
            foreach( IDTSOutputColumn100 col in output.OutputColumnCollection)
            {
               int colIndex = BufferManager.FindColumnByLineageID( output.Buffer, col.LineageID);
               // Note, buffer columns containing binary large objects
               // can not be set using the following syntax. Instead,
               // the AddBlobData and SetBytes methods are used.
               buf[colIndex] = rand.Next();
            }
         }
         buf.SetEndOfRowset();
      }
   }
}

Thread Safety

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