Skip to content

Commit a461c33

Browse files
authored
Minor: Update with_column_rename method doc (#8858)
* Minor: Update `with_column_rename` method doc
1 parent af3d190 commit a461c33

File tree

1 file changed

+6
-0
lines changed
  • datafusion/core/src/dataframe

1 file changed

+6
-0
lines changed

datafusion/core/src/dataframe/mod.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1156,6 +1156,11 @@ impl DataFrame {
11561156
/// Rename one column by applying a new projection. This is a no-op if the column to be
11571157
/// renamed does not exist.
11581158
///
1159+
/// The method supports case sensitive rename with wrapping column name into one of following symbols ( " or ' or ` )
1160+
///
1161+
/// Alternatively setting Datafusion param `datafusion.sql_parser.enable_ident_normalization` to `false` will enable
1162+
/// case sensitive rename without need to wrap column name into special symbols
1163+
///
11591164
/// ```
11601165
/// # use datafusion::prelude::*;
11611166
/// # use datafusion::error::Result;
@@ -1164,6 +1169,7 @@ impl DataFrame {
11641169
/// let ctx = SessionContext::new();
11651170
/// let df = ctx.read_csv("tests/data/example.csv", CsvReadOptions::new()).await?;
11661171
/// let df = df.with_column_renamed("ab_sum", "total")?;
1172+
///
11671173
/// # Ok(())
11681174
/// # }
11691175
/// ```

0 commit comments

Comments
 (0)