frameon.analyze_join_keys

analyze_join_keys(left_df: DataFrame, right_df: DataFrame, on: str | List[str] = None, left_on: str | List[str] = None, right_on: str | List[str] = None, short_result: bool = True, only_coverage: bool = False, how: Literal['all', 'inner', 'left', 'right', 'outer'] = 'all') → None

Analyzes key relationship and coverage between two DataFrames. Prints a formatted summary of the results and returns detailed metrics.

Parameters:

left_dfpd.DataFrame

Left DataFrame for analysis

right_dfpd.DataFrame

Right DataFrame for analysis

onstr or list, optional

Column name(s) present in both DataFrames (like pd.merge)

left_onstr or list, optional

Column name(s) in left DataFrame (like pd.merge)

right_onstr or list, optional

Column name(s) in right DataFrame (like pd.merge)

short_resultbool, optional

Whether to show short result

only_coverage: bool, default False

Whether to show only coverage between tables

howstr

Join type to show in short result. Can be one of ‘all’, ‘inner’, ‘left’, ‘right’, ‘outer’.

Returns:

None