Skip to content

Commit

Permalink
docs(python): warn about scan_pyarrow_dataset's limitations and sugge…
Browse files Browse the repository at this point in the history
…st scan_parquet instead (if possible) (#11952)
  • Loading branch information
MarcoGorelli authored Oct 23, 2023
1 parent 4c52ef2 commit cd612c9
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions py-polars/polars/io/pyarrow_dataset/functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,13 @@ def scan_pyarrow_dataset(
This can be useful to connect to cloud or partitioned datasets.
.. warning::
This method can only can push down predicates that are allowed by PyArrow
(e.g. not the full Polars API).
If :func:`scan_parquet` works for your source, you should use that instead.
Parameters
----------
source
Expand Down

0 comments on commit cd612c9

Please sign in to comment.