如何在 Spark DataFrame 中添加常量列？

Posted 2023-04-15

【中文标题】如何在 Spark DataFrame 中添加常量列？

【英文标题】：How to add a constant column in a Spark DataFrame?

【发布时间】：2015-09-25 18:17:14

【问题描述】：

我想在DataFrame 中添加一个具有任意值的列（每一行都相同）。当我使用withColumn 时出现错误，如下所示：

dt.withColumn('new_column', 10).head(5)

---------------------------------------------------------------------------
AttributeError                            Traceback (most recent call last)
<ipython-input-50-a6d0257ca2be> in <module>()
      1 dt = (messages
      2     .select(messages.fromuserid, messages.messagetype, floor(messages.datetime/(1000*60*5)).alias("dt")))
----> 3 dt.withColumn('new_column', 10).head(5)

/Users/evanzamir/spark-1.4.1/python/pyspark/sql/dataframe.pyc in withColumn(self, colName, col)
   1166         [Row(age=2, name=u'Alice', age2=4), Row(age=5, name=u'Bob', age2=7)]
   1167         """
-> 1168         return self.select('*', col.alias(colName))
   1169 
   1170     @ignore_unicode_prefix

AttributeError: 'int' object has no attribute 'alias'

似乎我可以通过添加和减去其他列之一（因此它们加到零）然后添加我想要的数字（在本例中为 10）来欺骗该函数：

dt.withColumn('new_column', dt.messagetype - dt.messagetype + 10).head(5)

[Row(fromuserid=425, messagetype=1, dt=4809600.0, new_column=10),
 Row(fromuserid=47019141, messagetype=1, dt=4809600.0, new_column=10),
 Row(fromuserid=49746356, messagetype=1, dt=4809600.0, new_column=10),
 Row(fromuserid=93506471, messagetype=1, dt=4809600.0, new_column=10),
 Row(fromuserid=80488242, messagetype=1, dt=4809600.0, new_column=10)]

这太骇人听闻了，对吧？我认为有更合法的方法可以做到这一点？

【参考方案1】：

Spark 2.2+

Spark 2.2 引入了typedLit 以支持Seq、Map 和Tuples (SPARK-19254)，并且应该支持以下调用 (Scala)：

import org.apache.spark.sql.functions.typedLit

df.withColumn("some_array", typedLit(Seq(1, 2, 3)))
df.withColumn("some_struct", typedLit(("foo", 1, 0.3)))
df.withColumn("some_map", typedLit(Map("key1" -> 1, "key2" -> 2)))

Spark 1.3+ (lit), 1.4+ (array, struct), 2.0+ (@987654330 @):

DataFrame.withColumn 的第二个参数应该是 Column，所以你必须使用文字：

from pyspark.sql.functions import lit

df.withColumn('new_column', lit(10))

如果您需要复杂的列，您可以使用 array 之类的块构建这些列：

from pyspark.sql.functions import array, create_map, struct

df.withColumn("some_array", array(lit(1), lit(2), lit(3)))
df.withColumn("some_struct", struct(lit("foo"), lit(1), lit(.3)))
df.withColumn("some_map", create_map(lit("key1"), lit(1), lit("key2"), lit(2)))

在 Scala 中可以使用完全相同的方法。

import org.apache.spark.sql.functions.array, lit, map, struct

df.withColumn("new_column", lit(10))
df.withColumn("map", map(lit("key1"), lit(1), lit("key2"), lit(2)))

要为structs 提供名称，请​​在每个字段上使用alias：

df.withColumn(
    "some_struct",
    struct(lit("foo").alias("x"), lit(1).alias("y"), lit(0.3).alias("z"))
 )

或cast 表示整个对象

df.withColumn(
    "some_struct", 
    struct(lit("foo"), lit(1), lit(0.3)).cast("struct<x: string, y: integer, z: double>")
 )

也可以使用 UDF，但速度较慢。

注意：

相同的结构可用于将常量参数传递给 UDF 或 SQL 函数。

【讨论】：

对于使用它来实现的其他人... withColumn 方法通过添加列或替换具有相同名称的现有列返回一个新的 DataFrame，因此您需要将结果重新分配给 df或分配给一个新变量。例如，`df = df.withColumn('new_column', lit(10))'

每次迭代，我们可以改变列内的值吗？我已经尝试过这个for i in range(len(item)) : df.withColumn('new_column', lit().format(i)) 但这不起作用

@zero323 你确定有一个名为“map”的函数可以将文字映射添加到代码中。

@BdEngineer 在 Scala 中是 map 在 Pyspark 中是 create_map

@Davos 谢谢，我连续有大约 20 列需要查找映射值...在 spark 中处理的最佳方法是什么？

【参考方案2】：

在spark 2.2中有两种方法可以在DataFrame的列中添加常量值：

1) 使用lit

2) 使用typedLit。

两者之间的区别在于typedLit 也可以处理参数化的 scala 类型，例如列表、序列和映射

示例数据帧：

val df = spark.createDataFrame(Seq((0,"a"),(1,"b"),(2,"c"))).toDF("id", "col1")

+---+----+
| id|col1|
+---+----+
|  0|   a|
|  1|   b|
+---+----+

1) 使用lit： 在名为 newcol 的新列中添加常量字符串值：

import org.apache.spark.sql.functions.lit
val newdf = df.withColumn("newcol",lit("myval"))

结果：

+---+----+------+
| id|col1|newcol|
+---+----+------+
|  0|   a| myval|
|  1|   b| myval|
+---+----+------+

2) 使用typedLit:

import org.apache.spark.sql.functions.typedLit
df.withColumn("newcol", typedLit(("sample", 10, .044)))

结果：

+---+----+-----------------+
| id|col1|           newcol|
+---+----+-----------------+
|  0|   a|[sample,10,0.044]|
|  1|   b|[sample,10,0.044]|
|  2|   c|[sample,10,0.044]|
+---+----+-----------------+

【讨论】：

能否分享完整版本以及导入声明

火花版本 2.2.1。 import 语句来自 pyspark.sql.functions import typedLit。也试过上面你分享的那个。

@Ayush Vatsyayan 如果我使用的是 java8 api，如何将这个 typedLit 与 Map 一起使用？请提供任何样品

【参考方案3】：

正如其他答案所描述的，lit 和 typedLit 是如何将常量列添加到 DataFrames。 lit 是一个重要的 Spark 函数，您会经常使用它，但不能用于向 DataFrame 添加常量列。

您通常会使用lit 创建org.apache.spark.sql.Column 对象，因为这是大多数org.apache.spark.sql.functions 所需的列类型。

假设您有一个包含 some_date DateType 列的 DataFrame，并且想要添加一个包含 2020 年 12 月 31 日和 some_date 之间日期的列。

这是你的数据框：

+----------+
| some_date|
+----------+
|2020-09-23|
|2020-01-05|
|2020-04-12|
+----------+

以下是如何计算到年底的天数：

val diff = datediff(lit(Date.valueOf("2020-12-31")), col("some_date"))
df
  .withColumn("days_till_yearend", diff)
  .show()

+----------+-----------------+
| some_date|days_till_yearend|
+----------+-----------------+
|2020-09-23|               99|
|2020-01-05|              361|
|2020-04-12|              263|
+----------+-----------------+

您还可以使用lit 创建year_end 列并计算days_till_yearend，如下所示：

import java.sql.Date

df
  .withColumn("yearend", lit(Date.valueOf("2020-12-31")))
  .withColumn("days_till_yearend", datediff(col("yearend"), col("some_date")))
  .show()

+----------+----------+-----------------+
| some_date|   yearend|days_till_yearend|
+----------+----------+-----------------+
|2020-09-23|2020-12-31|               99|
|2020-01-05|2020-12-31|              361|
|2020-04-12|2020-12-31|              263|
+----------+----------+-----------------+

大多数时候，您不需要使用 lit 将常量列附加到 DataFrame。您只需使用 lit 将 Scala 类型转换为 org.apache.spark.sql.Column 对象，因为这是函数所需要的。

查看datediff函数签名：

如您所见，datediff 需要两个 Column 参数。

【讨论】：

我们也可以使用withColumn("days_till_yearend", datediff(lit(Date.valueOf("2020-12-31")), col("some_date"))) 来否定创建变量diff 的需要吗？