Condividi tramite

Classe PipelineBuffer

  • Articolo

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

Gerarchia di ereditarietà

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

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

Sintassi

'Dichiarazione
Public Class PipelineBuffer _
    Implements IDisposable
'Utilizzo
Dim instance As PipelineBuffer

public class PipelineBuffer : IDisposable

public ref class PipelineBuffer : IDisposable

type PipelineBuffer =  
    class 
        interface IDisposable 
    end

public class PipelineBuffer implements IDisposable

Nel tipo PipelineBuffer sono esposti i membri seguenti.

Costruttori

  Nome Descrizione
Metodo protetto PipelineBuffer(IntPtr, PipelineBufferMode) Instantiates a new instance of the PipelineBuffer.
Metodo pubblico PipelineBuffer(UInt32, UInt32, UInt64, IntPtr*, DTP_BUFFCOL*, Boolean)

In alto

Proprietà

  Nome Descrizione
Proprietà pubblica ColumnCount Gets the number of columns in the PipelineBuffer.
Proprietà pubblica ColumnInfo
Proprietà pubblica CurrentRow Gets the index of the current row in the PipelineBuffer.
Proprietà pubblica EndOfRowset Gets a value indicating whether the current PipelineBuffer is the final buffer.
Proprietà pubblica Item Gets the data stored in a buffer column.
Proprietà pubblica Mode Gets a value indicating whether a PipelineBuffer is an IDTSInput100 buffer or an IDTSOutput100 buffer.
Proprietà pubblica RowCount Gets the number of rows in the PipelineBuffer object.
Proprietà pubblica RowSize
Proprietà pubblica RowStarts

In alto

Metodi

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

In alto

Osservazioni

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 Utilizzo di tipi di dati nel flusso di dati.

Esempi

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

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