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

Question

我想在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)]

这种方法非常巧妙，不是吗？我假设有更合法的方法可以做到这一点？

- Evan Zamir

Answer 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+ (map)：

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"))
 )

或在整个对象上转换

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

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

注意:

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

- zero323

---

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

在每次迭代中，我们可以更改列内的值吗？我已经尝试过这个代码：for i in range(len(item)) : df.withColumn('new_column', lit({}).format(i)) 但是它不起作用。 - Tracy

@zero323 你确定有一个名为“map”的函数可以将文字地图添加到代码中吗？ - BdEngineer

@BdEngineer 在Scala中是map，在Pyspark中是create_map。 - Davos

@Davos 谢谢，我有一行大约20列需要查找映射值...在Spark中处理的最佳方法是什么？ - BdEngineer

@BdEngineer，您能否添加一个更详细的问题描述和基本示例，并使用spark / pyspark标记它。这样其他人回答问题和查找答案会更容易，而不是在评论中寻找:D - Davos

Answer 2

在Spark 2.2中，有两种方法可以在DataFrame的列中添加常量值： 1）使用lit 2）使用typedLit。 两者之间的区别在于，typedLit还可以处理参数化的Scala类型，例如列表、序列和映射。 样例DataFrame：

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]|
+---+----+-----------------+

- Ayush Vatsyayan

---

你能分享完整版本以及导入语句吗？ - Ayush Vatsyayan

Spark版本为2.2.1。导入语句为from pyspark.sql.functions import typedLit。我也尝试了你之前分享的那个。 - braj

@Ayush Vatsyayan 如果我正在使用Java8 API，如何在Map中使用typedLit？请提供任何示例。 - BdEngineer

Answer 3

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

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

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

这是您的DataFrame：

+----------+
| 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 需要两个列参数。

- Powers

---

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

Answer 4

如果你想在pyspark的dataframe中添加新的列，并设置默认值，你可以使用withColumn和lit()函数来添加列。以下是一个示例：

df_new = df_old.withColumn('new_column_name',lit(New_value))

在这里，

• new_column_name - 你喜欢给的列名
• new_value - 你希望为所有记录设置的默认值。

谢谢

- Programmer