DataFrameComparison.joined_equal#

DataFrameComparison.joined_equal(
*subset: str,
lazy: Literal[True],
) → LazyFrame[source]#
DataFrameComparison.joined_equal(
*subset: str,
lazy: Literal[False] = False,
) → DataFrame

The rows of both data frames that can be joined and have matching values in in all columns in subset.

Parameters:

  • subset – The columns to check for mismatches. If not provided, all common columns are used.

  • 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 and have matching values across the specified columns.

Raises:

ValueError – If any of the provided columns are not common columns.

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.