You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2024/12/10 18:54:03 UTC
[PR] Minor: Add doc example to RecordBatchStreamAdapter [datafusion]
alamb opened a new pull request, #13725:
URL: https://github.com/apache/datafusion/pull/13725
## Which issue does this PR close?
Part of #7013
## Rationale for this change
While working on https://github.com/apache/datafusion/issues/13714 I got hung up (again) on creating a `SendableRecordBatchStream` from some batches (I forgot to `Box::pin` the `RecordBatchStreamAdapter` a while)
Let's put this in a documentation example on `RecordBatchStreamAdapter`
## What changes are included in this PR?
1. Add a doc example of using `RecordBatchStreamAdapter`
<!--
There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
-->
## Are these changes tested?
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code
If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
-->
## Are there any user-facing changes?
Only docs, no functional changes
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Minor: Add doc example to RecordBatchStreamAdapter [datafusion]
Posted by "berkaysynnada (via GitHub)" <gi...@apache.org>.
berkaysynnada commented on code in PR #13725:
URL: https://github.com/apache/datafusion/pull/13725#discussion_r1879551095
##########
datafusion/physical-plan/src/stream.rs:
##########
@@ -347,7 +349,28 @@ pin_project! {
}
impl<S> RecordBatchStreamAdapter<S> {
- /// Creates a new [`RecordBatchStreamAdapter`] from the provided schema and stream
+ /// Creates a new [`RecordBatchStreamAdapter`] from the provided schema and stream.
+ ///
+ /// Note to create a [`SendableRecordBatchStream`] you pun the result
Review Comment:
```suggestion
/// Note to create a [`SendableRecordBatchStream`] you pin the result
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Minor: Add doc example to RecordBatchStreamAdapter [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #13725:
URL: https://github.com/apache/datafusion/pull/13725#issuecomment-2539047633
🚀
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Minor: Add doc example to RecordBatchStreamAdapter [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb merged PR #13725:
URL: https://github.com/apache/datafusion/pull/13725
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Minor: Add doc example to RecordBatchStreamAdapter [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #13725:
URL: https://github.com/apache/datafusion/pull/13725#issuecomment-2535745767
Thank you for the review @berkaysynnada
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org