Skip to content

DOC: Add filesystem keyword arg and documentation to DataFrame.to_parquet #62924

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOC: Add filesystem keyword arg and documentation to DataFrame.to_parquet #62924

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2918,6 +2918,7 @@ def to_parquet(
index: bool | None = ...,
partition_cols: list[str] | None = ...,
storage_options: StorageOptions = ...,
filesystem: Any = ...,
**kwargs,
) -> bytes: ...

Expand All @@ -2931,6 +2932,7 @@ def to_parquet(
index: bool | None = ...,
partition_cols: list[str] | None = ...,
storage_options: StorageOptions = ...,
filesystem: Any = ...,
**kwargs,
) -> None: ...

Expand All @@ -2944,6 +2946,7 @@ def to_parquet(
index: bool | None = None,
partition_cols: list[str] | None = None,
storage_options: StorageOptions | None = None,
filesystem: Any = None,
**kwargs,
) -> bytes | None:
"""
Expand Down Expand Up @@ -2983,6 +2986,12 @@ def to_parquet(
Must be None if path is not a string.
{storage_options}

filesystem : fsspec or pyarrow filesystem, default None
Filesystem object to use when reading the parquet file. Only implemented
for ``engine="pyarrow"``.

.. versionadded:: 2.1.0

**kwargs
Additional arguments passed to the parquet library. See
:ref:`pandas io <io.parquet>` for more details.
Expand Down Expand Up @@ -3044,6 +3053,7 @@ def to_parquet(
index=index,
partition_cols=partition_cols,
storage_options=storage_options,
filesystem=filesystem,
**kwargs,
)

Expand Down
Loading