snowflake.snowpark.functions.booland_agg¶

snowflake.snowpark.functions.booland_agg(expr: Union[snowflake.snowpark.column.Column, str]) → Column[source]¶

Returns True if all input values are True (or equivalent to True). Returns False if any input value is False (or equivalent to False). None values are ignored unless all values are None, in which case None is returned.

Parameters:

expr (ColumnOrName) – The boolean values to aggregate.

Returns:

True if all values are True, False if any value is False, or None if all values are None.

Return type:

Column

Examples::
>>> df = session.create_dataframe([True, True, True], schema=["a"])
>>> df.select(booland_agg("a")).collect()
[Row(BOOLAND_AGG("A")=True)]
>>> df = session.create_dataframe([True, False, True], schema=["a"])
>>> df.select(booland_agg("a")).collect()
[Row(BOOLAND_AGG("A")=False)]
>>> df = session.create_dataframe([1, 2, 3], schema=["a"])
>>> df.select(booland_agg("a")).collect()
[Row(BOOLAND_AGG("A")=True)]
>>> df = session.create_dataframe([1, 0, 2], schema=["a"])
>>> df.select(booland_agg("a")).collect()
[Row(BOOLAND_AGG("A")=False)]
Copy