pyspark.sql.functions.bround#

pyspark.sql.functions.bround(col, scale=None)[source]#

Round the given value to scale decimal places using HALF_EVEN rounding mode if scale >= 0 or at integral part when scale < 0.

Added in version 2.0.0.

Changed in version 3.4.0: Supports Spark Connect.

Parameters:

colColumn or column name: The target column or column name to compute the round on. A column that evaluates to a numeric.
scaleColumn or int, optional: An optional parameter to control the rounding behavior. A column that evaluates to an integer. Must be a constant.

Changed in version 4.0.0: Support Column type.

Returns:

Column: A column for the rounded value. Returns a column of the same type as the input.

Examples

Example 1: Compute the rounded of a column value

>>> import pyspark.sql.functions as sf
>>> spark.range(1).select(sf.bround(sf.lit(2.5))).show()
+--------------+
|bround(2.5, 0)|
+--------------+
|           2.0|
+--------------+

Example 2: Compute the rounded of a column value with a specified scale

>>> import pyspark.sql.functions as sf
>>> spark.range(1).select(sf.bround(sf.lit(2.1267), sf.lit(2))).show()
+-----------------+
|bround(2.1267, 2)|
+-----------------+
|             2.13|
+-----------------+