GH-32320: [R] Docs unclear about potential disadvantages of dictionary encoding#50093
Closed
thisisnic wants to merge 1 commit into
Closed
GH-32320: [R] Docs unclear about potential disadvantages of dictionary encoding#50093thisisnic wants to merge 1 commit into
thisisnic wants to merge 1 commit into
Conversation
|
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR clarifies Arrow’s Parquet writer documentation (R and Python) to note that dictionary encoding—while often beneficial—can be counterproductive for high-cardinality columns by increasing file size and reducing compression effectiveness.
Changes:
- Expanded the R
write_parquet()roxygen docs foruse_dictionarywith guidance about high-cardinality columns. - Expanded the Python
pyarrow.parquetwriter argument docs foruse_dictionarywith the same cautionary note.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
r/R/parquet.R |
Adds an explicit warning in write_parquet() docs about dictionary encoding potentially worsening size/compression for many-unique-value columns. |
python/pyarrow/parquet/core.py |
Adds the same cautionary note to the Parquet writer argument documentation string under use_dictionary. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
Author
|
Closing this as we have a fallback and on reflection the original use case may have been a little niche and adding this to the docs may confuse things further |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rationale for this change
Unclear docs - dictionary encoding can slow stuff down but it's not apparent
What changes are included in this PR?
Talk about it
Are these changes tested?
Nah
Are there any user-facing changes?
Nope