search
Search
Login
Unlock 100+ guides
menu
menu
web
search toc
close
Comments
Log in or sign up
Cancel
Post
account_circle
Profile
exit_to_app
Sign out
What does this mean?
Why is this true?
Give me some examples!
search
keyboard_voice
close
Searching Tips
Search for a recipe:
"Creating a table in MySQL"
Search for an API documentation: "@append"
Search for code: "!dataframe"
Apply a tag filter: "#python"
Useful Shortcuts
/ to open search panel
Esc to close search panel
to navigate between search results
d to clear all current filters
Enter to expand content preview
icon_star
Doc Search
icon_star
Code Search Beta
SORRY NOTHING FOUND!
mic
Start speaking...
Voice search is only supported in Safari and Chrome.
Navigate to

PySpark SQL Functions | concat_ws method

schedule Aug 12, 2023
Last updated
local_offer
PySpark
Tags
mode_heat
Master the mathematics behind data science with 100+ top-tier guides
Start your free 7-days trial now!

PySpark SQL Functions' concat_ws(~) method concatenates string-typed columns into a single column with the specified separator.

Parameters

1. sep | string

The separator to use when concatenating the columns.

2. *cols | Column objects

The string-based columns to concatenate. If the type of the columns is not string, then automatic casting will be performed. If casting fails, then an error is thrown.

Return Value

A PySpark SQL Column object (pyspark.sql.column.Column).

Examples

Consider the following PySpark DataFrame:

df = spark.createDataFrame([("a", "b"), ("c", "d"), ("e", "f")], ["ONE", "TWO"])
df.show()
+---+---+
|ONE|TWO|
+---+---+
| a| b|
| c| d|
| e| f|
+---+---+

Concatenating multiple string columns in PySpark

To create a new PySpark DataFrame that combines the two string-typed columns:

import pyspark.sql.functions as F
df.select(F.concat_ws("-", df.ONE, df.TWO).alias("NEW")).show()
+---+
|NEW|
+---+
|a-b|
|c-d|
|e-f|
+---+

Here, we are using the alias(~) function of the Column object to supply the name of the newly combined column.

Note that we can combine more than two columns at once:

df.select(F.concat_ws("-", df.ONE, df.TWO, df.ONE).alias("NEW")).show()
+-----+
| NEW|
+-----+
|a-b-a|
|c-d-c|
|e-f-e|
+-----+
robocat
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...
thumb_up
0
thumb_down
0
chat_bubble_outline
0
settings
Enjoy our search
Hit / to insta-search docs and recipes!