DataFrameComparison.joined

DataFrameComparison.joined(

*,

lazy: Literal[True],

) → LazyFrame

DataFrameComparison.joined(

*,

lazy: Literal[False] = False,

) → DataFrame

The rows of both data frames that can be joined, regardless of whether column values match in columns which are not used for joining.

Parameters:

lazy – If True, return a lazy frame. Otherwise, return an eager frame (default).

Returns:

A data frame or lazy frame containing the rows that can be joined.

Columns which are not used for joining have a suffix _left for the left data frame and a suffix _right for the right data frame.