This is an automated email from the ASF dual-hosted git repository.
comphead pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new a461c3345b Minor: Update `with_column_rename` method doc (#8858)
a461c3345b is described below
commit a461c3345b8a727b3396af09f45058db0ddb5a8d
Author: comphead <[email protected]>
AuthorDate: Sun Jan 14 11:34:25 2024 -0800
Minor: Update `with_column_rename` method doc (#8858)
* Minor: Update `with_column_rename` method doc
---
datafusion/core/src/dataframe/mod.rs | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/datafusion/core/src/dataframe/mod.rs
b/datafusion/core/src/dataframe/mod.rs
index f15f1e9ba6..9d00dc72f1 100644
--- a/datafusion/core/src/dataframe/mod.rs
+++ b/datafusion/core/src/dataframe/mod.rs
@@ -1156,6 +1156,11 @@ impl DataFrame {
/// Rename one column by applying a new projection. This is a no-op if the
column to be
/// renamed does not exist.
///
+ /// The method supports case sensitive rename with wrapping column name
into one of following symbols ( " or ' or ` )
+ ///
+ /// Alternatively setting Datafusion param
`datafusion.sql_parser.enable_ident_normalization` to `false` will enable
+ /// case sensitive rename without need to wrap column name into special
symbols
+ ///
/// ```
/// # use datafusion::prelude::*;
/// # use datafusion::error::Result;
@@ -1164,6 +1169,7 @@ impl DataFrame {
/// let ctx = SessionContext::new();
/// let df = ctx.read_csv("tests/data/example.csv",
CsvReadOptions::new()).await?;
/// let df = df.with_column_renamed("ab_sum", "total")?;
+ ///
/// # Ok(())
/// # }
/// ```
