daft.DataFrame.join#

DataFrame.join(other: daft.dataframe.dataframe.DataFrame, on: Optional[Union[List[Union[daft.expressions.Expression, str]], daft.expressions.Expression, str]] = None, left_on: Optional[Union[List[Union[daft.expressions.Expression, str]], daft.expressions.Expression, str]] = None, right_on: Optional[Union[List[Union[daft.expressions.Expression, str]], daft.expressions.Expression, str]] = None, how: str = 'inner') → daft.dataframe.dataframe.DataFrame[source]#

Column-wise join of the current DataFrame with an other DataFrame, similar to a SQL JOIN

Note

Although self joins are supported, we currently duplicate the logical plan for the right side and recompute the entire tree. Caching for this is on the roadmap.

Parameters

  • other (DataFrame) – the right DataFrame to join on.

  • on (Optional[Union[List[ColumnInputType], ColumnInputType]], optional) – key or keys to join on [use if the keys on the left and right side match.]. Defaults to None.

  • left_on (Optional[Union[List[ColumnInputType], ColumnInputType]], optional) – key or keys to join on left DataFrame.. Defaults to None.

  • right_on (Optional[Union[List[ColumnInputType], ColumnInputType]], optional) – key or keys to join on right DataFrame. Defaults to None.

  • how (str, optional) – what type of join to performing, currently only inner is supported. Defaults to “inner”.

Raises

  • ValueError – if on is passed in and left_on or right_on is not None.

  • ValueError – if on is None but both left_on and right_on are not defined.

Returns

Joined DataFrame.

Return type

DataFrame