docs: Expand streaming user guide with 6 real-world patterns#26731
Open
ThotDjehuty wants to merge 4 commits intopola-rs:mainfrom
Open
docs: Expand streaming user guide with 6 real-world patterns#26731ThotDjehuty wants to merge 4 commits intopola-rs:mainfrom
ThotDjehuty wants to merge 4 commits intopola-rs:mainfrom
Conversation
Adds: larger_than_ram, sink_parquet, sink_csv, sink_batches, collect_async, partition_pruning Related: pola-rs#20947
Adds API summary table, ASCII memory model diagram, and sections for: larger_than_ram, sink_*, sink_batches, collect_async, partition_pruning. Related: pola-rs#20947
Adds: larger_than_ram, sink_parquet, sink_csv, sink_batches, collect_async, partition_pruning Related: pola-rs#20947
Adds API summary table, ASCII memory model diagram, and sections for: larger_than_ram, sink_*, sink_batches, collect_async, partition_pruning. Related: pola-rs#20947
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #26731 +/- ##
==========================================
- Coverage 81.43% 81.42% -0.02%
==========================================
Files 1801 1801
Lines 246750 246750
Branches 3081 3081
==========================================
- Hits 200936 200908 -28
- Misses 45028 45056 +28
Partials 786 786 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Member
|
Did you follow the AI policy? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The streaming page currently only covers
collect(engine="streaming")andshow_graph(). This PR expands it with actionable examples for the full streaming API surface.What's added
streaming.py— 6 new tagged code sections:larger_than_ramsink_parquetsink_parquet(full output never in RAM)sink_csvsink_csvsink_batchescollect_asyncasyncio.gather+collect_async()partition_pruningscan_parquetwith predicate pushdown skipping non-matching filesstreaming.md— expanded from ~1,500 to ~4,000 bytes:sink_*" section (sink_parquet+sink_csv)sink_batches" sectioncollect_async" sectionThe hidden comment
<!-- Not included in the docs "until we have something we are proud of" -->has been removed now that the page has substantive content.Testing
All examples are self-contained (iris fixture +
tempfile.TemporaryDirectory), requiring no external network access. Compatible with the existing docs CI.Related
#20947 (streaming engine tracking issue)