pyspark.sql.functions.struct

pyspark.sql.functions.struct(*cols: Union[ColumnOrName, List[ColumnOrName_], Tuple[ColumnOrName_, …]]) → pyspark.sql.column.Column

Creates a new struct column.

Parameters

colslist, set, str or Column

column names or Columns to contain in the output struct.

Examples

>>> df.select(struct('age', 'name').alias("struct")).collect()
[Row(struct=Row(age=2, name='Alice')), Row(struct=Row(age=5, name='Bob'))]
>>> df.select(struct([df.age, df.name]).alias("struct")).collect()
[Row(struct=Row(age=2, name='Alice')), Row(struct=Row(age=5, name='Bob'))]

previous

pyspark.sql.functions.spark_partition_id

next

pyspark.sql.functions.when