ETLBox
Title here
Summary here
IDataFlowComponent
Interface IDataFlowComponent
Inherited Members
Namespace: ETLBox
Assembly: ETLBox.dll
Syntax
public interface IDataFlowComponent : ILoggableTaskProperties
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
Task Completion { get; }Property Value
| Type | Description |
|---|---|
| Task |
ErrorSource
The ErrorSource is the source block used for sending errors into the linked error flow.
Declaration
ErrorSource ErrorSource { get; set; }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
Exception Exception { get; }Property Value
| Type | Description |
|---|---|
| Exception |
IsReadyForProcessing
Indicates if a component was successfully initialized, linked and prepared for execution.
Declaration
bool IsReadyForProcessing { get; }Property Value
| Type | Description |
|---|---|
| bool |
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
int MaxBufferSize { get; set; }Property Value
| Type | Description |
|---|---|
| int |
OnCompletion
When a component has completed and processed all rows, the OnCompletion action is executed.
Declaration
Action OnCompletion { get; set; }Property Value
| Type | Description |
|---|---|
| Action |
Predecessors
All predecessors that are linked to this component.
Declaration
List<DataFlowComponent> Predecessors { get; }Property Value
| Type | Description |
|---|---|
| List<DataFlowComponent> |
Successors
All successors that this component is linked to.
Declaration
List<DataFlowComponent> Successors { get; }Property Value
| Type | Description |
|---|---|
| List<DataFlowComponent> |
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
IDataFlowSource<ETLBoxError> LinkErrorTo(IDataFlowDestination<ETLBoxError> target)Parameters
| Type | Name | Description |
|---|---|---|
| IDataFlowDestination<ETLBoxError> | target | The target for erroneous rows. |
Returns
| Type | Description |
|---|---|
| IDataFlowSource<ETLBoxError> | The linked component. |