Skip to content

Commit

Permalink
Add unstable warning
Browse files Browse the repository at this point in the history
  • Loading branch information
stinodego committed Jun 20, 2024
1 parent 74d2262 commit a00dc17
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions py-polars/polars/lazyframe/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -1811,6 +1811,10 @@ def collect(
Run the query in the background and get a handle to the query.
This handle can be used to fetch the result or cancel the query.
.. warning::
Background mode is considered **unstable**. It may be changed
at any point without it being considered a breaking change.
Returns
-------
DataFrame
Expand Down Expand Up @@ -1887,7 +1891,9 @@ def collect(
_eager,
new_streaming,
)

if background:
issue_unstable_warning("Background mode is considered unstable.")
return InProcessQuery(ldf.collect_concurrently())

# Only for testing purposes atm.
Expand Down

0 comments on commit a00dc17

Please sign in to comment.