andygrove commented on code in PR #12651:
URL: https://github.com/apache/datafusion/pull/12651#discussion_r1779158669
##########
datafusion/execution/src/stream.rs:
##########
@@ -29,5 +31,23 @@ pub trait RecordBatchStream: Stream<Item =
Result<RecordBatch>> {
fn schema(&self) -> SchemaRef;
}
-/// Trait for a [`Stream`] of [`RecordBatch`]es
+/// Trait for a [`Stream`] of [`RecordBatch`]es that can be passed between
threads
+///
+/// This trait is used to retrieve the results of DataFusion execution plans.
+///
+/// The trait is a specialized Rust Async [`Stream`] that also knows the schema
+/// of the data it will return (even if the stream has no data). Every
+/// `RecordBatch` returned by the stream should have the same schema as
returned
+/// by [`schema`](`RecordBatchStream::schema`).
+///
+/// # Error Handling
+///
+/// One a stream returns an error, it should not be polled again (the caller
Review Comment:
```suggestion
/// Once a stream returns an error, it should not be polled again (the caller
```
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
