Interface IDataFlowComponent

Inherited Members

Namespace: ETLBox

Assembly: ETLBox.dll

Syntax

{{< /rawhtml >}} ```C# public interface IDataFlowComponent : ILoggableTask ``` {{< rawhtml >}}

Properties

Completion

The completion task of the component. A component is completed when all predecessors (if any) are completed and the current component has completed its buffer.

Declaration

{{< /rawhtml >}} ```C# Task Completion { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
Task

ErrorSource

The ErrorSource is the source block used for sending errors into the linked error flow.

Declaration

{{< /rawhtml >}} ```C# ErrorSource ErrorSource { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
ErrorSource

Exception

If a component encountered an exception or entered a fault state because another component in the data flow faulted, the thrown exception will be stored in this property.

Declaration

{{< /rawhtml >}} ```C# Exception Exception { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
Exception

ExecutionEndTime

Declaration

{{< /rawhtml >}} ```C# DateTimeOffset? ExecutionEndTime { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
DateTimeOffset?

ExecutionStartTime

Declaration

{{< /rawhtml >}} ```C# DateTimeOffset? ExecutionStartTime { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
DateTimeOffset?

IsReadyForProcessing

Indicates if a component was successfully initialized, linked and prepared for execution.

Declaration

{{< /rawhtml >}} ```C# bool IsReadyForProcessing { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
bool

LogThreshold

To avoid getting log message for every message, by default only log message are produced when 1000 rows are processed. Set this property to decrease or increase this value.

Declaration

{{< /rawhtml >}} ```C# int? LogThreshold { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
int?

MaxBufferSize

Each component can have one or more buffers to improve throughput and allow faster processing of data. Set this value to restrict the number of rows that can be stored in the buffer. The default value is -1 (unlimited)

Declaration

{{< /rawhtml >}} ```C# int MaxBufferSize { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
int

OnCompletion

When a component has completed and processed all rows, the OnCompletion action is executed.

Declaration

{{< /rawhtml >}} ```C# Action OnCompletion { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
Action

OnProgress

This delegate is invoked each time the progress counter changes

Declaration

{{< /rawhtml >}} ```C# Action OnProgress { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
Action<int>

Predecessors

All predecessors that are linked to this component.

Declaration

{{< /rawhtml >}} ```C# List Predecessors { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
List<DataFlowComponent>

ProgressCount

The amount of rows the current component has already processed.

Declaration

{{< /rawhtml >}} ```C# int ProgressCount { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
int

Successors

All successors that this component is linked to.

Declaration

{{< /rawhtml >}} ```C# List Successors { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
List<DataFlowComponent>

Tag

A tag that can be used to store any object in the component.

Declaration

{{< /rawhtml >}} ```C# object Tag { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
object

Methods

LinkErrorTo(IDataFlowDestination<ETLBoxError>)

If an error occurs in the component, by default the component will throw an exception and stop execution. If you use the error linking, any erroneous records will be caught and redirected.

Declaration

{{< /rawhtml >}} ```C# IDataFlowSource LinkErrorTo(IDataFlowDestination target) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
IDataFlowDestination<ETLBoxError>	target	The target for erroneous rows.

Returns

Type	Description
IDataFlowSource<ETLBoxError>	The linked component.