Compartir a través de

  • Artículo

Clase PipelineBuffer

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

Jerarquía de herencia

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

Espacio de nombres:  Microsoft.SqlServer.Dts.Pipeline
Ensamblado:  Microsoft.SqlServer.PipelineHost (en Microsoft.SqlServer.PipelineHost.dll)

Sintaxis

'Declaración
Public Class PipelineBuffer _
    Implements IDisposable
'Uso
Dim instance As PipelineBuffer

public class PipelineBuffer : IDisposable

public ref class PipelineBuffer : IDisposable

type PipelineBuffer =  
    class
        interface IDisposable
    end

public class PipelineBuffer implements IDisposable

El tipo PipelineBuffer expone los siguientes miembros.

Constructores

  Nombre Descripción
Método protegido PipelineBuffer Instantiates a new instance of the PipelineBuffer.

Arriba

Propiedades

  Nombre Descripción
Propiedad pública ColumnCount Gets the number of columns in the PipelineBuffer.
Propiedad pública CurrentRow Gets the index of the current row in the PipelineBuffer.
Propiedad pública EndOfRowset Gets a value indicating whether the current PipelineBuffer is the final buffer.
Propiedad pública Item Gets the data stored in a buffer column.
Propiedad pública Mode Gets a value indicating whether a PipelineBuffer is an IDTSInput100 buffer or an IDTSOutput100 buffer.
Propiedad pública RowCount Gets the number of rows in the PipelineBuffer object.

Arriba

Métodos

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

Arriba

Comentarios

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 Trabajar con tipos de datos del flujo de datos.

Ejemplos

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

Seguridad para subprocesos

Cualquier miembro público static (Shared en Visual Basic) de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.