Skip to content

Commit d97f936

Browse files
adriangbCopilot
andauthored
Update datafusion/datasource/src/mod.rs
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent cd66667 commit d97f936

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

  • datafusion/datasource/src

datafusion/datasource/src/mod.rs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,15 @@ pub struct PartitionedFile {
134134
/// When set via [`Self::with_statistics`], partition column statistics are automatically
135135
/// computed from [`Self::partition_values`] with exact min/max/null_count/distinct_count.
136136
pub statistics: Option<Arc<Statistics>>,
137-
/// A known ordering of the data in this file.
137+
/// The known lexicographical ordering of the rows in this file, if any.
138+
///
139+
/// This describes how the data within the file is sorted with respect to one or more
140+
/// columns, and is used by the optimizer for planning operations that depend on input
141+
/// ordering (e.g. merges, sorts, and certain aggregations).
142+
///
143+
/// When available, this is typically inferred from file-level metadata exposed by the
144+
/// underlying format (for example, Parquet `sorting_columns`), but it may also be set
145+
/// explicitly via [`Self::with_ordering`].
138146
pub ordering: Option<LexOrdering>,
139147
/// An optional field for user defined per object metadata
140148
pub extensions: Option<Arc<dyn std::any::Any + Send + Sync>>,

0 commit comments

Comments
 (0)