Class Pivot<TInput>
Use the Pivot transformation to pivot your data.
Inheritance
Pivot<TInput>
Namespace: ETLBox.DataFlow
Assembly: ETLBox.dll
Syntax
{{< /rawhtml >}}
```C#
public class Pivot : DataFlowTransformation, IDataFlowTransformation, IDataFlowSource, IDataFlowSource, IDataFlowDestination, IDataFlowDestination, IDataFlowComponent, ILoggableTask
```
{{< rawhtml >}}
Type Parameters
| Name |
Description |
| TInput |
Type of incoming rows
|
Examples
Month,MonthValue
Jan,100
Feb,200
Mar,300
will become
Jan,Feb,Mar
100,200,300
Constructors
Pivot()
Declaration
{{< /rawhtml >}}
```C#
public Pivot()
```
{{< rawhtml >}}
Properties
AddGrandTotalColumn
Adds a grand total for each column.
Declaration
{{< /rawhtml >}}
```C#
public bool AddGrandTotalColumn { get; set; }
```
{{< rawhtml >}}
Property Value
AddGrandTotalRows
Adds a grand total for each column.
Declaration
{{< /rawhtml >}}
```C#
public bool AddGrandTotalRows { get; set; }
```
{{< rawhtml >}}
Property Value
ColumnNameCombination
If set, this function is used to combine the column name for the pivoted columns.
Otherwise, the output will concatenate the names of the pivot columns.
Declaration
{{< /rawhtml >}}
```C#
public Func, string> ColumnNameCombination { get; set; }
```
{{< rawhtml >}}
Property Value
CustomValueAggregation
Use the ValueAggregationFunc to define how to handle aggregation of the values in the input data.
Setting this function is not required. If you don't set it, the PivotValues attributes and their
AggregationMethod (or CustomFunction) will be used to aggregate the values. If set,
this will override any CustomFunction or AggregationMethod set in the PivotValues attributes.
Declaration
{{< /rawhtml >}}
```C#
public Func.ValueAggregationInput, object> CustomValueAggregation { get; set; }
```
{{< rawhtml >}}
Property Value
FlattenAggregationResults
This only applies if 2 or more PivotValues are specified.
All PivotValues will be aggregated into an array of PivotAggregationResult objects.
This function can be used to flatten the array of PivotAggregationResult objects into a single value.
Declaration
{{< /rawhtml >}}
```C#
public Func FlattenAggregationResults { get; set; }
```
{{< rawhtml >}}
Property Value
KeepEmptyValues
By default, all rows will contain all columns, even if they are empty (null).
Set this to false, and the dynamic output object won't contain columns that are empty/null.
Declaration
{{< /rawhtml >}}
```C#
public bool KeepEmptyValues { get; set; }
```
{{< rawhtml >}}
Property Value
MaxBufferSize
Declaration
{{< /rawhtml >}}
```C#
public int MaxBufferSize { get; }
```
{{< rawhtml >}}
Property Value
PivotColumns
Columns by which the data should be pivoted - all other columns will be kept as a group column.
If you want to avoid grouping, you need to remove these columns from your data before using the pivot transformation.
(E.g. with the ColumnTransformation<TInput>)
Declaration
{{< /rawhtml >}}
```C#
public ICollection PivotColumns { get; set; }
```
{{< rawhtml >}}
Property Value
PivotRows
The rows that are kept in the output. If not set, all rows are kept.
Declaration
{{< /rawhtml >}}
```C#
public ICollection PivotRows { get; set; }
```
{{< rawhtml >}}
Property Value
PivotValues
Value columns which contain the values for the pivot columns.
Declaration
{{< /rawhtml >}}
```C#
public ICollection PivotValues { get; set; }
```
{{< rawhtml >}}
Property Value
ProgressCount
Declaration
{{< /rawhtml >}}
```C#
public int ProgressCount { get; }
```
{{< rawhtml >}}
Property Value
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
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
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
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
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
Returns
Overrides
PrepareParameterForCheck()
Declaration
{{< /rawhtml >}}
```C#
protected override void PrepareParameterForCheck()
```
{{< rawhtml >}}
Overrides
Reset()
Declaration
{{< /rawhtml >}}
```C#
protected override void Reset()
```
{{< rawhtml >}}
Overrides
Implements
{{< /rawhtml >}}