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 all 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
23 changes: 23 additions & 0 deletions doc/source/merging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -692,6 +692,29 @@ 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_dup.png
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. It is the user' s responsibility to manage duplicate values in keys before joining large DataFrames.

.. _merging.indicator:

Expand Down