pyspark.sql.functions.bool_or

pyspark.sql.functions.bool_or(col)

Aggregate function: returns true if at least one value of col is true.

Added in version 3.5.0.

Parameters:

colColumn or column name

column to check if at least one value is true.

Returns:

Column

true if at least one value of col is true, false otherwise.

See also

pyspark.sql.functions.bool_and()

Examples

>>> df = spark.createDataFrame([[True], [True], [True]], ["flag"])
>>> df.select(bool_or("flag")).show()
+-------------+
|bool_or(flag)|
+-------------+
|         true|
+-------------+
>>> df = spark.createDataFrame([[True], [False], [True]], ["flag"])
>>> df.select(bool_or("flag")).show()
+-------------+
|bool_or(flag)|
+-------------+
|         true|
+-------------+
>>> df = spark.createDataFrame([[False], [False], [False]], ["flag"])
>>> df.select(bool_or("flag")).show()
+-------------+
|bool_or(flag)|
+-------------+
|        false|
+-------------+