Package org.apache.datafusion

Enum Class JoinType

java.lang.Object

java.lang.Enum<JoinType>

org.apache.datafusion.JoinType

All Implemented Interfaces:

Serializable, Comparable<JoinType>, Constable

public enum JoinType
extends Enum<JoinType>

Join algorithm requested for DataFrame.join(org.apache.datafusion.DataFrame, org.apache.datafusion.JoinType, java.lang.String[], java.lang.String[]) / DataFrame.joinOn(org.apache.datafusion.DataFrame, org.apache.datafusion.JoinType, java.lang.String...). Mirrors DataFusion's JoinType enum one-to-one.

• INNER — rows where the join condition matches in both sides.
• LEFT / RIGHT — outer joins; unmatched rows on the named side are kept and padded with nulls on the other side.
• FULL — full outer join; unmatched rows from either side are kept with nulls.
• LEFT_SEMI / RIGHT_SEMI — returns rows from the named side that have at least one match on the other; only the named side's columns appear in the output.
• LEFT_ANTI / RIGHT_ANTI — returns rows from the named side that have no match on the other; only the named side's columns appear in the output.
• LEFT_MARK / RIGHT_MARK — returns one row per row of the named side, with an additional boolean mark column indicating whether the join condition matched.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FULL
INNER
LEFT
LEFT_ANTI
LEFT_MARK
LEFT_SEMI
RIGHT
RIGHT_ANTI
RIGHT_MARK
RIGHT_SEMI

Method Summary

Modifier and Type	Method	Description
byte	code()	Stable byte code for FFI.
static JoinType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JoinType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INNER

public static final JoinType INNER

LEFT

public static final JoinType LEFT

RIGHT

public static final JoinType RIGHT

FULL

public static final JoinType FULL

LEFT_SEMI

public static final JoinType LEFT_SEMI

RIGHT_SEMI

public static final JoinType RIGHT_SEMI

LEFT_ANTI

public static final JoinType LEFT_ANTI

RIGHT_ANTI

public static final JoinType RIGHT_ANTI

LEFT_MARK

public static final JoinType LEFT_MARK

RIGHT_MARK

public static final JoinType RIGHT_MARK

Method Details

values

public static JoinType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static JoinType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

code

public byte code()

Stable byte code for FFI.