
        
        
            
                
                
                    df = spark.createDataFrame([["Alex", 25], ["Bob", 30]], ["name", "age"])
df.show()
                
            
            +----+---+
|name|age|
+----+---+
|Alex| 25|
| Bob| 30|
+----+---+

Replacing column labels of PySpark DataFrame

To replace the column label age with AGE:


        
        
            
                
                
                    df.withColumnRenamed("age", "AGE").show()
                
            
            +----+---+
|name|AGE|
+----+---+
|Alex| 25|
| Bob| 30|
+----+---+

Note that no error will be thrown if the column label you want to replace does not exist:


        
        
            
                
                
                    df.withColumnRenamed("ageeee", "AGE").show()
                
            
            +----+---+
|name|age|
+----+---+
|Alex| 25|
| Bob| 30|
+----+---+

Notice how the original DataFrame is returned in such cases.

Replacing multiple column labels of PySpark DataFrame

To replace multiple column labels at once, we can chain the withColumnRenamed(-) method like so:


        
        
            
                
                
                    df.withColumnRenamed("age", "AGE").withColumnRenamed("name", "NAME").show()
                
            
            +----+---+
|NAME|AGE|
+----+---+
|Alex| 25|
| Bob| 30|
+----+---+

Published by Isshin Inada

Edited by 0 others

Did you find this page useful?

thumb_up

thumb_down

Comment

Citation

Ask a question or leave a feedback...

Official PySpark Documentation

https://spark.apache.org/docs/latest/api/python/reference/api/pyspark.sql.DataFrame.withColumnRenamed.html

thumb_up

thumb_down

chat_bubble_outline

settings

Enjoy our search

Hit / to insta-search docs and recipes!