Поделиться через

  • Статья

Класс PipelineBuffer

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

Иерархия наследования

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

Пространство имен:  Microsoft.SqlServer.Dts.Pipeline
Сборка:  Microsoft.SqlServer.PipelineHost (в Microsoft.SqlServer.PipelineHost.dll)

Синтаксис

'Декларация
Public Class PipelineBuffer _
    Implements IDisposable
'Применение
Dim instance As PipelineBuffer

public class PipelineBuffer : IDisposable

public ref class PipelineBuffer : IDisposable

type PipelineBuffer =  
    class
        interface IDisposable
    end

public class PipelineBuffer implements IDisposable

Тип PipelineBuffer обеспечивает доступ к следующим элементам.

Конструкторы

  Имя Описание
Защищенный метод PipelineBuffer Instantiates a new instance of the PipelineBuffer.

В начало

Свойства

  Имя Описание
Открытое свойство ColumnCount Gets the number of columns in the PipelineBuffer.
Открытое свойство CurrentRow Gets the index of the current row in the PipelineBuffer.
Открытое свойство EndOfRowset Gets a value indicating whether the current PipelineBuffer is the final buffer.
Открытое свойство Item Gets the data stored in a buffer column.
Открытое свойство Mode Gets a value indicating whether a PipelineBuffer is an IDTSInput100 buffer or an IDTSOutput100 buffer.
Открытое свойство RowCount Gets the number of rows in the PipelineBuffer object.

В начало

Методы

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

В начало

Замечания

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 Работа с типами данных в потоке данных.

Примеры

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

Безопасность многопоточности

Любые открытые статический (Shared в Visual Basic) элементы этого типа потокобезопасны. Потокобезопасность с элементами экземпляров не гарантируется.