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

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

或 cast 在整个对象上

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

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

笔记：

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

---

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

1) 使用 lit

2) 使用typedLit。

两者的区别在于 typedLit 还可以处理参数化的 scala 类型，例如 List、Seq 和 Map

示例数据框：

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

---

正如其他答案所描述的，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 函数签名：

https://i.stack.imgur.com/1RBwk.png

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

---