Class DataFlowBatchDestination<TInput>

Inheritance
System.Object
GenericTask
DataFlowTask
DataFlowDestination<TInput[]>
DataFlowBatchDestination<TInput>
DbDestination<TInput>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: ETLBox.DataFlow
Assembly: ETLBox.dll
Syntax
public abstract class DataFlowBatchDestination<TInput> : DataFlowDestination<TInput[]>, IDataFlowDestination<TInput[]>, IDataFlowLinkTarget<TInput[]>, IDataFlowBatchDestination<TInput>, IDataFlowDestination<TInput>, IDataFlowLinkTarget<TInput>, ITask
Type Parameters
Name Description
TInput

Fields

DEFAULT_BATCH_SIZE

Declaration
public const int DEFAULT_BATCH_SIZE = 1000
Field Value
Type Description
System.Int32

Properties

AfterBatchWrite

This action is called after a batch was successfully inserted into the destination. You will get a copy of the data that was used for the insertion.

Declaration
public Action<TInput[]> AfterBatchWrite { get; set; }
Property Value
Type Description
System.Action<TInput[]>

BatchSize

The batch size defines how many records needs to be in the Input buffer before data is written into the destination. The default batch size is 1000.

Declaration
public int BatchSize { get; set; }
Property Value
Type Description
System.Int32

BeforeBatchWrite

This function is called every time before a batch is inserted into the destination. It receives an array that represents the batch - you can modify the data itself if needed.

Declaration
public Func<TInput[], TInput[]> BeforeBatchWrite { get; set; }
Property Value
Type Description
System.Func<TInput[], TInput[]>

Buffer

Declaration
protected BatchBlock<TInput> Buffer { get; set; }
Property Value
Type Description
System.Threading.Tasks.Dataflow.BatchBlock<TInput>

TargetBlock

The buffer component used as target for linking.

Declaration
public ITargetBlock<TInput> TargetBlock { get; }
Property Value
Type Description
System.Threading.Tasks.Dataflow.ITargetBlock<TInput>

WasInitialized

Declaration
protected bool WasInitialized { get; set; }
Property Value
Type Description
System.Boolean

Methods

AddPredecessorCompletion(Task)

Use this method if you want to register a task that needs to be completed before the destination itself can complete. Normally you don't have to do anything - all linked components will automatically register using this method. Simple use the LinkTo() method of source components or transformations.

Declaration
public void AddPredecessorCompletion(Task completion)
Parameters
Type Name Description
System.Threading.Tasks.Task completion

A task to wait for before this destination can complete.

CheckCompleteAction()

Declaration
protected void CheckCompleteAction()

CleanUp()

Declaration
protected override void CleanUp()
Overrides
ETLBox.DataFlow.DataFlowDestination<TInput[]>.CleanUp()

FinishWrite()

Declaration
protected abstract void FinishWrite()

InitObjects(Int32)

Declaration
protected virtual void InitObjects(int batchSize)
Parameters
Type Name Description
System.Int32 batchSize

PrepareWrite()

Declaration
protected abstract void PrepareWrite()

TryBulkInsertData(TInput[])

Declaration
protected abstract void TryBulkInsertData(TInput[] data)
Parameters
Type Name Description
TInput[] data

WriteBatch(TInput[])

Declaration
protected void WriteBatch(TInput[] data)
Parameters
Type Name Description
TInput[] data

Implements