Skip to content

Commit

Permalink
Document expected behaviour
Browse files Browse the repository at this point in the history
  • Loading branch information
Jefffrey committed Nov 28, 2023
1 parent fd662ad commit ef9601e
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion parquet/src/arrow/async_reader/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,15 @@ impl<T> std::fmt::Debug for ParquetRecordBatchStream<T> {
}

impl<T> ParquetRecordBatchStream<T> {
/// Returns the [`SchemaRef`] for this parquet file
/// Returns the [`SchemaRef`] for this parquet file.
///
/// Note that unlike its synchronous counterpart [`ParquetRecordBatchReader`], the [`SchemaRef`]
/// returned here will contain the original metadata, whereas [`ParquetRecordBatchReader`]
/// strips this metadata.
///
/// As such, this schema is the same as [`ParquetRecordBatchStreamBuilder::schema`] which also
/// contains the metadata, but differs from the [`RecordBatch`]es produced which have the metadata
/// in their [`RecordBatch::schema`] stripped.
pub fn schema(&self) -> &SchemaRef {
&self.schema
}
Expand Down

0 comments on commit ef9601e

Please sign in to comment.