Skip to content

DOC: warning section on memory overflow when joining/merging dataframes on index with duplicate keys #14788

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Dec 11, 2016
Merged
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions doc/source/merging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -692,6 +692,30 @@ either the left or right tables, the values in the joined table will be
p.plot([left, right], result,
labels=['left', 'right'], vertical=False);
plt.close('all');

Here is another example with duplicate join keys in DataFrames:

.. ipython:: python

left = pd.DataFrame({'A' : [1,2], 'B' : [2, 2]})

right = pd.DataFrame({'A' : [4,5,6], 'B': [2,2,2]})

result = pd.merge(left, right, on='B', how='outer')

.. ipython:: python
:suppress:

@savefig merging_merge_on_key_multiple.png
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you past the picture in the PR for us to see

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

p.plot([left, right], result,
labels=['left', 'right'], vertical=False);
plt.close('all');

.. warning::

Joining / merging on duplicate keys can cause a returned frame that is the multiplication of the row dimensions,
may result in memory overflow, which can be dangerous for unsaved work.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove 'which can be dangerou...'

The last sentence should be something like: it is the users responsibility to manage duplicate values in keys before join......

Please make sure no duplicate values in keys before joining large DataFrames.

.. _merging.indicator:

Expand Down Expand Up @@ -817,6 +841,7 @@ equivalent:
left.join(right, on=key_or_keys)
pd.merge(left, right, left_on=key_or_keys, right_index=True,
how='left', sort=False)


Obviously you can choose whichever form you find more convenient. For
many-to-one joins (where one of the DataFrame's is already indexed by the join
Expand Down