hipdf.DataFrame.join

Contents

hipdf.DataFrame.join#

21 min read time

Applies to Linux

DataFrame.join(other, on=None, how='left', lsuffix='', rsuffix='', sort=False, validate: str | None = None)#

Join columns with other DataFrame on index or on a key column.

Parameters#

other : DataFrame how : str

Only accepts “left”, “right”, “inner”, “outer”

lsuffix, rsuffixstr

The suffices to add to the left (lsuffix) and right (rsuffix) column names when avoiding conflicts.

sortbool

Set to True to ensure sorted ordering.

validatestr, optional

If specified, checks if join is of specified type.

  • “one_to_one” or “1:1”: check if join keys are unique in both left and right datasets.

  • “one_to_many” or “1:m”: check if join keys are unique in left dataset.

  • “many_to_one” or “m:1”: check if join keys are unique in right dataset.

  • “many_to_many” or “m:m”: allowed, but does not result in checks.

Currently not supported.

Returns#

joined : DataFrame

Contents