pyspark.sql.functions.nvl#

pyspark.sql.functions.nvl(col1, col2)[source]#

Returns col2 if col1 is null, or col1 otherwise.

New in version 3.5.0.

Parameters
col1Column or column name
col2Column or column name

Examples

>>> import pyspark.sql.functions as sf
>>> df = spark.createDataFrame([(None, 8,), (1, 9,)], ["a", "b"])
>>> df.select('*', sf.nvl(df.a, df.b)).show()
+----+---+---------+
|   a|  b|nvl(a, b)|
+----+---+---------+
|NULL|  8|        8|
|   1|  9|        1|
+----+---+---------+
>>> df.select('*', sf.nvl('a', 'b')).show()
+----+---+---------+
|   a|  b|nvl(a, b)|
+----+---+---------+
|NULL|  8|        8|
|   1|  9|        1|
+----+---+---------+