Skip to content

Commit ef9601e

Browse files
committed
Document expected behaviour
1 parent fd662ad commit ef9601e

File tree

1 file changed

+9
-1
lines changed
  • parquet/src/arrow/async_reader

1 file changed

+9
-1
lines changed

parquet/src/arrow/async_reader/mod.rs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -572,7 +572,15 @@ impl<T> std::fmt::Debug for ParquetRecordBatchStream<T> {
572572
}
573573

574574
impl<T> ParquetRecordBatchStream<T> {
575-
/// Returns the [`SchemaRef`] for this parquet file
575+
/// Returns the [`SchemaRef`] for this parquet file.
576+
///
577+
/// Note that unlike its synchronous counterpart [`ParquetRecordBatchReader`], the [`SchemaRef`]
578+
/// returned here will contain the original metadata, whereas [`ParquetRecordBatchReader`]
579+
/// strips this metadata.
580+
///
581+
/// As such, this schema is the same as [`ParquetRecordBatchStreamBuilder::schema`] which also
582+
/// contains the metadata, but differs from the [`RecordBatch`]es produced which have the metadata
583+
/// in their [`RecordBatch::schema`] stripped.
576584
pub fn schema(&self) -> &SchemaRef {
577585
&self.schema
578586
}

0 commit comments

Comments
 (0)