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 example in to_pyarrow_dataset #2315

Merged
merged 3 commits into from
Mar 22, 2024
Merged

docs: add example in to_pyarrow_dataset #2315

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71ff82a
docs
ion-elgreco Mar 22, 2024
4ce28d4
typo
ion-elgreco Mar 22, 2024
96aabe0
Merge branch 'main' into docs/give_example_pyarrow_dataset
rtyler Mar 22, 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
17 changes: 16 additions & 1 deletion python/deltalake/table.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1029,6 +1029,22 @@ def to_pyarrow_dataset(

More info: https://arrow.apache.org/docs/python/generated/pyarrow.dataset.ParquetReadOptions.html

Example:
``deltalake`` will work with any storage compliant with :class:`pyarrow.fs.FileSystem`, however the root of the filesystem has
to be adjusted to point at the root of the Delta table. We can achieve this by wrapping the custom filesystem into
a :class:`pyarrow.fs.SubTreeFileSystem`.
```
import pyarrow.fs as fs
from deltalake import DeltaTable

table_uri = "s3://<bucket>/<path>"
raw_fs, normalized_path = fs.FileSystem.from_uri(table_uri)
filesystem = fs.SubTreeFileSystem(normalized_path, raw_fs)

dt = DeltaTable(table_uri)
ds = dt.to_pyarrow_dataset(filesystem=filesystem)
```

Returns:
the PyArrow dataset in PyArrow
"""
Expand Down Expand Up @@ -1063,7 +1079,6 @@ def to_pyarrow_dataset(
self._table.table_uri(), self._storage_options, file_sizes
)
)

format = ParquetFileFormat(
read_options=parquet_read_options,
default_fragment_scan_options=ParquetFragmentScanOptions(pre_buffer=True),
Expand Down
Loading