# ColumnTransformation {{< rawhtml >}}

Class ColumnTransformation<TInput>

Allows you to rename, remove, reorder, or add columns/properties of your ingoing data. This transformation works with objects and dynamic ExpandoObjects as input data type. It will always convert the input type into an ExpandoObject as output. Added properties are appended after the reorganized input columns. A non-empty AddColumns list replaces AddColumn attributes. If ValueFunc is set, it replaces the constant value.

Inheritance
object
LoggableTask
DataFlowComponent
DataFlowSource<ExpandoObject>
DataFlowTransformation<TInput, ExpandoObject>
ColumnTransformation<TInput>
ColumnTransformation
ColumnTransformation
Implements
IDataFlowTransformation<TInput, ExpandoObject>
IDataFlowSource<ExpandoObject>
IDataFlowSource
IDataFlowDestination<TInput>
IDataFlowDestination
IDataFlowComponent
ILoggableTask
Inherited Members
DataFlowTransformation<TInput, ExpandoObject>.TargetBlock
DataFlowTransformation<TInput, ExpandoObject>.CompleteBuffer()
DataFlowTransformation<TInput, ExpandoObject>.FaultBuffer(Exception)
DataFlowSource<ExpandoObject>.LinkTo(IDataFlowDestination<ExpandoObject>)
DataFlowSource<ExpandoObject>.LinkTo(IDataFlowDestination<ExpandoObject>, Predicate<ExpandoObject>)
DataFlowSource<ExpandoObject>.LinkTo(IDataFlowDestination<ExpandoObject>, Predicate<ExpandoObject>, Predicate<ExpandoObject>)
DataFlowSource<ExpandoObject>.LinkTo<TConvert>(IDataFlowDestination<ExpandoObject>)
DataFlowSource<ExpandoObject>.LinkTo<TConvert>(IDataFlowDestination<ExpandoObject>, Predicate<ExpandoObject>)
DataFlowSource<ExpandoObject>.LinkTo<TConvert>(IDataFlowDestination<ExpandoObject>, Predicate<ExpandoObject>, Predicate<ExpandoObject>)
DataFlowComponent.MaxBufferSize
DataFlowComponent.Predecessors
DataFlowComponent.Successors
DataFlowComponent.Completion
DataFlowComponent.BufferCancellationSource
DataFlowComponent.BufferCancellationToken
DataFlowComponent.WasComponentInitialized
DataFlowComponent.IsReadyForProcessing
DataFlowComponent.SetParentComponent(DataFlowComponent)
DataFlowComponent.InternalLinkTo<T>(IDataFlowDestination, object, object)
DataFlowComponent.AddComplementVoidLinkToOtherTargets(Func<Type, IDataFlowDestination>, Delegate)
DataFlowComponent.ResetComponent()
DataFlowComponent.InitBufferObjects(CancellationToken?)
DataFlowComponent.InitCheckedParameter()
DataFlowComponent.OnInitialization
DataFlowComponent.OnCompletion
DataFlowComponent.OnException
DataFlowComponent.CompleteOrFaultBufferOnPredecessorCompletion(Task)
DataFlowComponent.Exception
DataFlowComponent.ErrorSource
DataFlowComponent.CancelBufferAndThrowOperationCanceledException()
DataFlowComponent.InternalLinkErrorTo(IDataFlowDestination<ETLBoxError>)
DataFlowComponent.ThrowOrRedirectError(Exception, string, string)
DataFlowComponent.ThrowErrorAndFaultNetwork(Exception, string)
DataFlowComponent.CancelComponent()
DataFlowComponent.ErrorCount
DataFlowComponent.OnProgress
DataFlowComponent.ExecutionStartTime
DataFlowComponent.ExecutionEndTime
DataFlowComponent.Tag
DataFlowComponent.LoggingStartOnce()
DataFlowComponent.LoggingFinishOnce()
DataFlowComponent.LogProgressBatch_AfterThrowOrRedirectError(int)
DataFlowComponent.LogProgress_AfterThrowOrRedirectError()
LoggableTask.TaskType
LoggableTask.TaskName
LoggableTask.DisableLogging
LoggableTask.LogThreshold
LoggableTask.TaskHash
LoggableTask.LogInstance
LoggableTask.ParentTask
LoggableTask.LogTrace(string, params object[])
LoggableTask.LogDebug(string, params object[])
LoggableTask.LogInfo(string, params object[])
LoggableTask.LogInfoOrDebug(string, params object[])
LoggableTask.LogWarn(string, params object[])
LoggableTask.LogError(string, params object[])
LoggableTask.LogFatal(string, params object[])
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: ETLBox.DataFlow
Assembly: ETLBox.dll
Syntax
{{< /rawhtml >}} ```C# public class ColumnTransformation : DataFlowTransformation, IDataFlowTransformation, IDataFlowSource, IDataFlowSource, IDataFlowDestination, IDataFlowDestination, IDataFlowComponent, ILoggableTask ``` {{< rawhtml >}}
Type Parameters
Name Description
TInput

Type of ingoing data

Constructors

ColumnTransformation()

Declaration
{{< /rawhtml >}} ```C# public ColumnTransformation() ``` {{< rawhtml >}}

Properties

AddColumns

Defines new properties appended to the output object, in list order. A non-empty list replaces AddColumn attributes on the input type. If an entry has ValueFunc set, that function replaces its constant value.

Declaration
{{< /rawhtml >}} ```C# public ICollection AddColumns { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
ICollection<AddColumn>

AddFunc

Optional function invoked once per row after AddColumns. Return a name and value to append one more property, or null to append nothing.

Declaration
{{< /rawhtml >}} ```C# public Func AddFunc { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
Func<TInput, AddedColumn>

ProgressCount

Declaration
{{< /rawhtml >}} ```C# public int ProgressCount { get; } ``` {{< rawhtml >}}
Property Value
Type Description
int

RemoveColumns

The remove columns defines if an existing property/column should be removed from the output object.

Declaration
{{< /rawhtml >}} ```C# public ICollection RemoveColumns { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
ICollection<RemoveColumn>

RemoveFunc

Instead (or additional) to existing column removing provided via the RemoveColumns property or the RemoveColumn attribute, you can define your own function to decide if a property should be removed.

Declaration
{{< /rawhtml >}} ```C# public Func RemoveFunc { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
Func<string, bool>

RenameColumns

The rename columns defines how existing properties/columns are renamed. For objects and dynamic object provide a mapping with the old and the new name. The mapping can also be automatically retrieved from RenameColumn attributes on the properties in strongly typed objects.

Declaration
{{< /rawhtml >}} ```C# public ICollection RenameColumns { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
ICollection<RenameColumn>

RenameFunc

Instead (or additional) to existing column renaming provided via the RenameColumns property or the RenameColumn attribute, you can define your own renaming function. It is called for each column in each row from the input, and allows you to transform the column/property name into a different property name.

Declaration
{{< /rawhtml >}} ```C# public Func RenameFunc { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
Func<string, string>

ReorderColumns

The reorder columns defines how existing properties/columns are ordered when creating the output object.

Declaration
{{< /rawhtml >}} ```C# public ICollection ReorderColumns { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
ICollection<ReorderColumn>

ReorderFunc

Instead (or additional) to existing column reordering provided via the ReorderColumns property or the ReorderColumn attribute, you can define your own function to set the new index of a property.

Declaration
{{< /rawhtml >}} ```C# public Func ReorderFunc { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
Func<string, object>

SourceBlock

SourceBlock from the underlying TPL.Dataflow which is used as output buffer for the component.

Declaration
{{< /rawhtml >}} ```C# public override ISourceBlock SourceBlock { get; } ``` {{< rawhtml >}}
Property Value
Type Description
ISourceBlock<ExpandoObject>
Overrides

TargetBlock

TargetBlock from the underlying TPL.Dataflow which is used as input buffer for the component.

Declaration
{{< /rawhtml >}} ```C# public override ITargetBlock TargetBlock { get; } ``` {{< rawhtml >}}
Property Value
Type Description
ITargetBlock<TInput>
Overrides

Methods

CheckParameter()

Declaration
{{< /rawhtml >}} ```C# protected override void CheckParameter() ``` {{< rawhtml >}}
Overrides

CleanUpOnFaulted(Exception)

Declaration
{{< /rawhtml >}} ```C# protected override void CleanUpOnFaulted(Exception e) ``` {{< rawhtml >}}
Parameters
Type Name Description
Exception e
Overrides

CleanUpOnSuccess()

Declaration
{{< /rawhtml >}} ```C# protected override void CleanUpOnSuccess() ``` {{< rawhtml >}}
Overrides

CompleteBuffer()

Declaration
{{< /rawhtml >}} ```C# protected override void CompleteBuffer() ``` {{< rawhtml >}}
Overrides

FaultBuffer(Exception)

Declaration
{{< /rawhtml >}} ```C# protected override void FaultBuffer(Exception e) ``` {{< rawhtml >}}
Parameters
Type Name Description
Exception e
Overrides

InitComponent()

Declaration
{{< /rawhtml >}} ```C# protected override void InitComponent() ``` {{< rawhtml >}}
Overrides

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# public override 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.
Overrides

PrepareParameterForCheck()

Declaration
{{< /rawhtml >}} ```C# protected override void PrepareParameterForCheck() ``` {{< rawhtml >}}
Overrides

Reset()

Declaration
{{< /rawhtml >}} ```C# protected override void Reset() ``` {{< rawhtml >}}
Overrides

Implements

{{< /rawhtml >}}