Skip to content

Commit

Permalink
docs: add writer properties to docs (#2002)
Browse files Browse the repository at this point in the history
# Description
Forgot to add WriterProperties to the docs page and mark a deprecation
in the docs.
  • Loading branch information
ion-elgreco authored Jan 2, 2024
1 parent 093a756 commit 1f9898a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/api/delta_writer.md
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
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:
Args:
data_page_size_limit: Limit DataPage size to this in bytes.
Expand Down

0 comments on commit 1f9898a

Please sign in to comment.