pandas.Index.join

Index.join(other, how='left', level=None, return_indexers=False, sort=False) [source]

Compute join_index and indexers to conform data structures to the new index.

Parameters:
other : Index
how : {‘left’, ‘right’, ‘inner’, ‘outer’}
level : int or level name, default None
return_indexers : boolean, default False
sort : boolean, default False

Sort the join keys lexicographically in the result Index. If False, the order of the join keys depends on the join type (how keyword)

New in version 0.20.0.

Returns:
join_index, (left_indexer, right_indexer)

© 2008–2012, AQR Capital Management, LLC, Lambda Foundry, Inc. and PyData Development Team
Licensed under the 3-clause BSD License.
https://pandas.pydata.org/pandas-docs/version/0.24.2/reference/api/pandas.Index.join.html