Skip to content
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

Jump to bottom

docs: add writer properties to docs #2002

Merged
merged 4 commits into from
Jan 2, 2024
Merged

docs: add writer properties to docs #2002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cb8229e
add writer properties to docs
ion-elgreco Dec 30, 2023
33efa70
Merge branch 'main' into docs/writer_properties
ion-elgreco Jan 2, 2024
0e03ea5
Merge branch 'main' into docs/writer_properties
ion-elgreco Jan 2, 2024
6ef48b7
Merge branch 'main' into docs/writer_properties
ion-elgreco Jan 2, 2024
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
2 changes: 2 additions & 0 deletions docs/api/delta_writer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ search:

::: deltalake.write_deltalake

::: deltalake.WriterProperties

## Convert to Delta Tables
::: deltalake.convert_to_deltalake

Expand Down
5 changes: 4 additions & 1 deletion python/deltalake/table.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1178,7 +1178,10 @@ def with_writer_properties(
write_batch_size: Optional[int] = None,
max_row_group_size: Optional[int] = None,
) -> "TableMerger":
"""Pass writer properties to the Rust parquet writer, see options https://arrow.apache.org/rust/parquet/file/properties/struct.WriterProperties.html:
"""
!!! warning "Deprecated"
Use `.merge(writer_properties = WriterProperties())` instead
Pass writer properties to the Rust parquet writer, see options https://arrow.apache.org/rust/parquet/file/properties/struct.WriterProperties.html:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we use something other than "Rust Parquet writer" for the Python API docs?

I would rather link to our docs than a third party page? Can we add a "Python version" of all these options to the documentation?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

There is a short description of each argument, I only kept the rust docs link in there in case people want to request more properties to be exposed.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@MrPowers what shall we do? Would be good to merge this since the new release contains the WriterProperties but the docs not yet if we don't merge this : P

Copy link
Collaborator

Choose a reason for hiding this comment

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

@ion-elgreco - merge away! We can always improve the docs later!


Args:
data_page_size_limit: Limit DataPage size to this in bytes.
Expand Down
Loading