pyflink.dataframe.dataframe.DataFrame.join

DataFrame.join(other: DataFrame, on: str | Expression | List[str] | None = None, how: str = 'inner', left_on: str | Expression | List[str] | None = None, right_on: str | Expression | List[str] | None = None) → DataFrame

Join with another DataFrame.

Parameters:

• other – Right DataFrame to join.

• on – Join key(s) when both DataFrames have the same column names.

• how – Join type. One of “inner”, “left”, “right”, “full”, “outer”.

• left_on – Left join key(s).

• right_on – Right join key(s).

Returns:

A new DataFrame with the join result.

Example::

>>> df1.join(df2, on="id")
>>> df1.join(df2, left_on="id", right_on="user_id")
>>> df1.join(df2, on=["id", "name"], how="left")