menu
home
About
 store
Store
 paid
Pricing
login
Log in
team_dashboard
Dashboard
near_me
Linear Algebra
casino
Prob and Stats
function
Other math topics
smart_toy
Machine Learning
Pandas
NumPy
Matplotlib
PySpark
MySQL
Dagster (NEW)
SkyTowner
BETA
search
Search
Login
Unlock 100+ guides
menu
menu
web
SkyTowner
search toc
close
history_edu
Blog
 help
Help
Outline
ParametersReturn ValueExamples
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.
fullscreen_exit
Shrink
north_east
Navigate to
PySpark
147 guides
keyboard_arrow_down
near_me
Linear Algebra
54 guides
 casino
Prob and Stats
38 guides
 smart_toy
Machine Learning
36 guides
 function
Other math topics
10 guides
Dagster
11 guides
Pandas
655 guides
NumPy
319 guides
Matplotlib
83 guides
PySpark
147 guides
MySQL
295 guides
chevron_leftPySpark SQL Functions
Method arrayMethod colMethod collect_listMethod collect_setMethod concatMethod concat_wsMethod countMethod count_distinctMethod countDistinctMethod date_addMethod date_formatMethod dayofmonthMethod dayofweekMethod dayofyearMethod element_atMethod explodeMethod exprMethod firstMethod greatestMethod instrMethod isnanMethod lastMethod leastMethod lengthMethod litMethod lowerMethod maxMethod meanMethod minMethod monthMethod regexp_extractMethod regexp_replaceMethod repeatMethod roundMethod splitMethod to_dateMethod translateMethod trimMethod upperMethod whenMethod year
check_circle
Mark as learned
thumb_up
1
thumb_down
0
chat_bubble_outline
0
Comment
auto_stories Bi-column layout
settings

PySpark SQL Functions | array method

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

PySpark SQL Functions' array(~) method combines multiples columns into a single column of arrays.

NOTE

If you want to combine multiple columns of array-type, then use the concat(~) instead.

Parameters

1. *cols | string or Column

The columns to combine.

Return Value

A new PySpark Column.

Examples

Consider the following PySpark DataFrame:

df = spark.createDataFrame([['A', 'a', '1'], ['B', 'b', '2'], ['C', 'c', '3']], ['col1', 'col2', 'col3'])
df.show()
+----+----+----+
|col1|col2|col3|
+----+----+----+
| A| a| 1|
| B| b| 2|
| C| c| 3|
+----+----+----+

To combine the columns col1, col2 and col3 into a single column of arrays, use the array(~) method:

from pyspark.sql import functions as F
# Assign label to PySpark column returned by array(~) using alias(~)
df.select(F.array('col1','col2','col3').alias('combined_col')).show()
+------------+
|combined_col|
+------------+
| [A, a, 1]|
| [B, b, 2]|
| [C, c, 3]|
+------------+

Instead of passing a column labels, we could also supply Column objects instead:

df.select(F.array(F.col('col1'),df['col2'],'col3').alias('combined_col')).show()
+------------+
|combined_col|
+------------+
| [A, a, 1]|
| [B, b, 2]|
| [C, c, 3]|
+------------+
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...
Official PySpark Documentation
https://spark.apache.org/docs/3.1.3/api/python/reference/api/pyspark.sql.functions.array.html
thumb_up
1
thumb_down
0
chat_bubble_outline
0
settings
Enjoy our search
Hit / to insta-search docs and recipes!
Navigation
Home Blog
Contact us
Resources
Python Pandas MySQL Beautiful Soup Matplotlib NumPy PySpark
Community
Join our Discord
 mail
Join our newsletter for updates on new comprehensive DS/ML guides
Terms
|
Privacy