Class ColumnRename<TInput>

ColumnRename allows you to rename the column or properties names of your ingoing data. This transformation works with objects, ExpandoObjects and arrays as input data type.
Provide a column mapping with the old and the new name. The mapping can also be automatically retrieved from existing ColumnMap attributes. For arrays provide the array index and the new name.

Inheritance
System.Object
LoggableTask
DataFlowComponent
DataFlowSource<System.Dynamic.ExpandoObject>
DataFlowTransformation<TInput, System.Dynamic.ExpandoObject>
ColumnRename<TInput>
ColumnRename
Implements
IDataFlowTransformation<TInput, System.Dynamic.ExpandoObject>
IDataFlowSource<System.Dynamic.ExpandoObject>
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.Transformations
Assembly: ETLBox.dll
Syntax
public class ColumnRename<TInput> : DataFlowTransformation<TInput, ExpandoObject>, ILoggableTask, IDataFlowLogging, IDataFlowTransformation<TInput, ExpandoObject>, IDataFlowSource<ExpandoObject>, IDataFlowSource, IDataFlowDestination<TInput>, IDataFlowDestination, IDataFlowComponent
Type Parameters
Name Description
TInput

Type of ingoing data

Constructors

ColumnRename()

Declaration
public ColumnRename()

ColumnRename(IEnumerable<ColumnMap>)

Declaration
public ColumnRename(IEnumerable<ColumnMap> columnMap)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<ColumnMap> columnMap

Properties

ColumnMapping

The column mapping defines how existing properties or 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 existing ColumnMap attributes - in this case, leave it empty. For arrays provide the array index and the new name.

Declaration
public IEnumerable<ColumnMap> ColumnMapping { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<ColumnMap>

RemoveColumns

Declaration
public IEnumerable<string> RemoveColumns { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.String>

SourceBlock

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

Declaration
public override ISourceBlock<ExpandoObject> SourceBlock { get; }
Property Value
Type Description
System.Threading.Tasks.Dataflow.ISourceBlock<System.Dynamic.ExpandoObject>
Overrides
ETLBox.DataFlow.DataFlowSource<System.Dynamic.ExpandoObject>.SourceBlock

TargetBlock

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

Declaration
public override ITargetBlock<TInput> TargetBlock { get; }
Property Value
Type Description
System.Threading.Tasks.Dataflow.ITargetBlock<TInput>
Overrides
ETLBox.DataFlow.DataFlowTransformation<TInput, System.Dynamic.ExpandoObject>.TargetBlock

TaskName

A name to identify the task or component. Every component or task comes with a default name that can be overwritten.

Declaration
public override string TaskName { get; set; }
Property Value
Type Description
System.String
Overrides

Methods

CleanUpOnFaulted(Exception)

Declaration
protected override void CleanUpOnFaulted(Exception e)
Parameters
Type Name Description
System.Exception e
Overrides

CleanUpOnSuccess()

Declaration
protected override void CleanUpOnSuccess()
Overrides

InternalInitBufferObjects()

Declaration
protected override void InternalInitBufferObjects()
Overrides

LinkErrorTo(IDataFlowDestination<ETLBoxError>)

Declaration
public IDataFlowSource<ETLBoxError> LinkErrorTo(IDataFlowDestination<ETLBoxError> target)
Parameters
Type Name Description
IDataFlowDestination<ETLBoxError> target
Returns
Type Description
IDataFlowSource<ETLBoxError>

Implements