Skip to content
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.

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

feat: add alias() method for DataFrame #14127

Merged
merged 6 commits into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
11 changes: 11 additions & 0 deletions datafusion/core/src/dataframe/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1903,6 +1903,17 @@ impl DataFrame {
let mem_table = MemTable::try_new(schema, partitions)?;
context.read_table(Arc::new(mem_table))
}

/// Apply an alias to the DataFrame.
///
/// This method replaces the qualifiers of output columns with the given alias.
pub fn alias(self, alias: &str) -> Result<DataFrame> {
let plan = LogicalPlanBuilder::from(self.plan).alias(alias)?.build()?;
Ok(DataFrame {
session_state: self.session_state,
plan,
})
}
}

#[derive(Debug)]
Expand Down
55 changes: 55 additions & 0 deletions datafusion/core/tests/dataframe/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2646,3 +2646,58 @@ async fn boolean_dictionary_as_filter() {

assert_batches_eq!(expected, &result_df.collect().await.unwrap());
}

#[tokio::test]
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks @jonahgao, nice PR, I would also add a test with some edge cases like nested alias, empty string alias

Copy link
Member Author

Choose a reason for hiding this comment

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

Added in af5136b

async fn test_alias() -> Result<()> {
let df = create_test_table("test")
.await?
.select(vec![col("a"), col("test.b"), lit(1).alias("one")])?
.alias("table_alias")?;
// All ouput column qualifiers are changed to "table_alias"
df.schema().columns().iter().for_each(|c| {
assert_eq!(c.relation, Some("table_alias".into()));
});
let expected = "SubqueryAlias: table_alias [a:Utf8, b:Int32, one:Int32]\
\n Projection: test.a, test.b, Int32(1) AS one [a:Utf8, b:Int32, one:Int32]\
\n TableScan: test [a:Utf8, b:Int32]";
let plan = df
.clone()
.into_unoptimized_plan()
.display_indent_schema()
.to_string();
assert_eq!(plan, expected);

// Select over the aliased DataFrame
let df = df.select(vec![
col("table_alias.a"),
col("b") + col("table_alias.one"),
])?;
let expected = [
"+-----------+---------------------------------+",
"| a | table_alias.b + table_alias.one |",
"+-----------+---------------------------------+",
"| abcDEF | 2 |",
"| abc123 | 11 |",
"| CBAdef | 11 |",
"| 123AbcDef | 101 |",
"+-----------+---------------------------------+",
];
assert_batches_sorted_eq!(expected, &df.collect().await?);

// Use alias to perform a self-join
let left = create_test_table("t1").await?;
let right = left.clone().alias("t2")?;
let joined = left.join(right, JoinType::Full, &["a"], &["a"], None)?;
let expected = [
"+-----------+-----+-----------+-----+",
"| a | b | a | b |",
"+-----------+-----+-----------+-----+",
"| abcDEF | 1 | abcDEF | 1 |",
"| abc123 | 10 | abc123 | 10 |",
"| CBAdef | 10 | CBAdef | 10 |",
"| 123AbcDef | 100 | 123AbcDef | 100 |",
"+-----------+-----+-----------+-----+",
];
assert_batches_sorted_eq!(expected, &joined.collect().await?);
Ok(())
}
Loading