Skip to content

DOC: Update doc of parquet compression parameter #51554

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.

Sign up for GitHub

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 4 commits into from
Feb 25, 2023
Merged

DOC: Update doc of parquet compression parameter #51554

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1a10d37
Update documentation of parquet compression parameter
ChristofKaufmann Feb 22, 2023
436f027
Put default value in first line
ChristofKaufmann Feb 23, 2023
924aaba
Merge branch 'pandas-dev:main' into doc-parquet-compression
ChristofKaufmann Feb 25, 2023
47502d1
Shorten first line of compression parameter doc
ChristofKaufmann Feb 25, 2023
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
6 changes: 5 additions & 1 deletion pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2801,8 +2801,12 @@ def to_parquet(
``io.parquet.engine`` is used. The default ``io.parquet.engine``
behavior is to try 'pyarrow', falling back to 'fastparquet' if
'pyarrow' is unavailable.
compression : {{'snappy', 'gzip', 'brotli', None}}, default 'snappy'
compression : str or None, default 'snappy'
Name of the compression to use. Use ``None`` for no compression.
The supported compression methods actually depend on which engine
is used. For 'pyarrow', 'snappy', 'gzip', 'brotli', 'lz4', 'zstd'
are all supported. For 'fastparquet', only 'gzip' and 'snappy' are
supported.
index : bool, default None
If ``True``, include the dataframe's index(es) in the file output.
If ``False``, they will not be written to the file.
Expand Down