DataFrame.Join Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
Join(DataFrame, Column, String) |
Join with another |
Join(DataFrame, IEnumerable<String>, String) |
Equi-join with another |
Join(DataFrame) |
Join with another |
Join(DataFrame, String) |
Inner equi-join with another |
Join(DataFrame, Column, String)
Join with another DataFrame
, using the given join expression.
public Microsoft.Spark.Sql.DataFrame Join(Microsoft.Spark.Sql.DataFrame right, Microsoft.Spark.Sql.Column joinExpr, string joinType = "inner");
member this.Join : Microsoft.Spark.Sql.DataFrame * Microsoft.Spark.Sql.Column * string -> Microsoft.Spark.Sql.DataFrame
Public Function Join (right As DataFrame, joinExpr As Column, Optional joinType As String = "inner") As DataFrame
Parameters
- right
- DataFrame
Right side of the join operator
- joinExpr
- Column
Join expression
- joinType
- String
Type of join to perform. Default inner
. Must be one of:
inner
, cross
, outer
, full
, full_outer
, left
, left_outer
, right
,
right_outer
, left_semi
, left_anti
.
Returns
Applies to
Join(DataFrame, IEnumerable<String>, String)
Equi-join with another DataFrame
using the given columns. A cross join with
a predicate is specified as an inner join. If you would explicitly like to
perform a cross join use the crossJoin
method.
public Microsoft.Spark.Sql.DataFrame Join(Microsoft.Spark.Sql.DataFrame right, System.Collections.Generic.IEnumerable<string> usingColumns, string joinType = "inner");
member this.Join : Microsoft.Spark.Sql.DataFrame * seq<string> * string -> Microsoft.Spark.Sql.DataFrame
Public Function Join (right As DataFrame, usingColumns As IEnumerable(Of String), Optional joinType As String = "inner") As DataFrame
Parameters
- right
- DataFrame
Right side of the join operator
- usingColumns
- IEnumerable<String>
Name of columns to join on
- joinType
- String
Type of join to perform. Default inner
. Must be one of:
inner
, cross
, outer
, full
, full_outer
, left
, left_outer
, right
,
right_outer
, left_semi
, left_anti
Returns
DataFrame object
Applies to
Join(DataFrame)
Join with another DataFrame
.
public Microsoft.Spark.Sql.DataFrame Join(Microsoft.Spark.Sql.DataFrame right);
member this.Join : Microsoft.Spark.Sql.DataFrame -> Microsoft.Spark.Sql.DataFrame
Public Function Join (right As DataFrame) As DataFrame
Parameters
- right
- DataFrame
Right side of the join operator
Returns
DataFrame object
Remarks
Behaves as an INNER JOIN and requires a subsequent join predicate.
Applies to
Join(DataFrame, String)
Inner equi-join with another DataFrame
using the given column.
public Microsoft.Spark.Sql.DataFrame Join(Microsoft.Spark.Sql.DataFrame right, string usingColumn);
member this.Join : Microsoft.Spark.Sql.DataFrame * string -> Microsoft.Spark.Sql.DataFrame
Public Function Join (right As DataFrame, usingColumn As String) As DataFrame
Parameters
- right
- DataFrame
Right side of the join operator
- usingColumn
- String
Name of the column to join on. This column must exist on both sides.
Returns
DataFrame object