Skip to content

Fix SortExec discards field metadata on the output schema #1477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Dandandan merged 1 commit into from
Dec 23, 2021
Merged

Fix SortExec discards field metadata on the output schema #1477

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 54 additions & 10 deletions datafusion/src/physical_plan/sort.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ use crate::physical_plan::{
};
pub use arrow::compute::SortOptions;
use arrow::compute::{lexsort_to_indices, take, SortColumn, TakeOptions};
use arrow::datatypes::{Field, Schema, SchemaRef};
use arrow::datatypes::SchemaRef;
use arrow::error::Result as ArrowResult;
use arrow::record_batch::RecordBatch;
use arrow::{array::ArrayRef, error::ArrowError};
Expand Down Expand Up @@ -201,15 +201,6 @@ fn sort_batch(
None,
)?;

let schema = Arc::new(Schema::new(
Copy link
Contributor Author

@alamb alamb Dec 22, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the fix is to delete this code, the rest of the PR is a test

Copy link
Contributor

@Dandandan Dandandan Dec 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice and clean 🧹🧼

schema
.fields()
.iter()
.zip(batch.columns().iter().map(|col| col.data_type()))
.map(|(field, ty)| Field::new(field.name(), ty.clone(), field.is_nullable()))
.collect::<Vec<_>>(),
));

// reorder all rows based on sorted indices
RecordBatch::try_new(
schema,
Expand Down Expand Up @@ -318,6 +309,8 @@ impl RecordBatchStream for SortStream {

#[cfg(test)]
mod tests {
use std::collections::{BTreeMap, HashMap};

use super::*;
use crate::datasource::object_store::local::LocalFileSystem;
use crate::physical_plan::coalesce_partitions::CoalescePartitionsExec;
Expand Down Expand Up @@ -398,6 +391,57 @@ mod tests {
Ok(())
}

#[tokio::test]
async fn test_sort_metadata() -> Result<()> {
let field_metadata: BTreeMap<String, String> =
vec![("foo".to_string(), "bar".to_string())]
.into_iter()
.collect();
let schema_metadata: HashMap<String, String> =
vec![("baz".to_string(), "barf".to_string())]
.into_iter()
.collect();

let mut field = Field::new("field_name", DataType::UInt64, true);
field.set_metadata(Some(field_metadata.clone()));
let schema = Schema::new_with_metadata(vec![field], schema_metadata.clone());
let schema = Arc::new(schema);

let data: ArrayRef =
Arc::new(vec![3, 2, 1].into_iter().map(Some).collect::<UInt64Array>());

let batch = RecordBatch::try_new(schema.clone(), vec![data]).unwrap();
let input =
Arc::new(MemoryExec::try_new(&[vec![batch]], schema.clone(), None).unwrap());

let sort_exec = Arc::new(SortExec::try_new(
vec![PhysicalSortExpr {
expr: col("field_name", &schema)?,
options: SortOptions::default(),
}],
input,
)?);

let result: Vec<RecordBatch> = collect(sort_exec).await?;

let expected_data: ArrayRef =
Arc::new(vec![1, 2, 3].into_iter().map(Some).collect::<UInt64Array>());
let expected_batch =
RecordBatch::try_new(schema.clone(), vec![expected_data]).unwrap();

// Data is correct
assert_eq!(&vec![expected_batch], &result);

// explicitlty ensure the metadata is present
assert_eq!(
result[0].schema().fields()[0].metadata(),
&Some(field_metadata)
);
assert_eq!(result[0].schema().metadata(), &schema_metadata);

Ok(())
}

#[tokio::test]
async fn test_lex_sort_by_float() -> Result<()> {
let schema = Arc::new(Schema::new(vec![
Expand Down