DataFlow.Join Method

Definition

Creates a new Dataflow that is a result of joining this Dataflow with the provided right_dataflow.

public Microsoft.DataPrep.Common.DataFlow Join(Microsoft.DataPrep.Common.DataFlow rightDataFlow, System.Collections.Generic.List<System.Collections.Generic.KeyValuePair<string,string>> joinKeyPairs, Microsoft.DataPrep.Common.JoinType joinType = Microsoft.DataPrep.Common.JoinType.Inner, string leftColumnPrefix = "l_", string rightColumnPrefix = "r_", System.Collections.Generic.List<string> leftNonePrefixedColumns = null, System.Collections.Generic.List<string> rightNonePrefixedColumns = null);
member this.Join : Microsoft.DataPrep.Common.DataFlow * System.Collections.Generic.List<System.Collections.Generic.KeyValuePair<string, string>> * Microsoft.DataPrep.Common.JoinType * string * string * System.Collections.Generic.List<string> * System.Collections.Generic.List<string> -> Microsoft.DataPrep.Common.DataFlow

Parameters

rightDataFlow
DataFlow

Right Dataflow or DataflowReference to join with.

joinKeyPairs
List<KeyValuePair<String,String>>

Key column pairs. List of tuples of columns names where each tuple forms a key pair to join on. For instance: [(column_from_left_dataflow, column_from_right_dataflow)]

joinType
JoinType

Type of join to perform. Match is default.

leftColumnPrefix
String

Prefix to use in result Dataflow for columns originating from left_dataflow. Needed to avoid column name conflicts at runtime.

rightColumnPrefix
String

Prefix to use in result Dataflow for columns originating from right_dataflow. Needed to avoid column name conflicts at runtime.

leftNonePrefixedColumns
List<String>

List of column names from left_dataflow that should not be prefixed with left_column_prefix. Every other column appearing in the data at runtime will be prefixed.

rightNonePrefixedColumns
List<String>

List of column names from right_dataflow that should not be prefixed with right_column_prefix. Every other column appearing in the data at runtime will be prefixed.

Returns

The new Dataflow.

Applies to