pyspark.sql.functions.format_number

pyspark.sql.functions.format_number(col: ColumnOrName, d: int) → pyspark.sql.column.Column

Formats the number X to a format like ‘#,–#,–#.–’, rounded to d decimal places with HALF_EVEN round mode, and returns the result as a string.

New in version 1.5.0.

Changed in version 3.4.0: Supports Spark Connect.

Parameters

colColumn or str

the column name of the numeric value to be formatted

dint

the N decimal places

Returns

Column

the column of formatted results.

>>> spark.createDataFrame([(5,)], ['a']).select(format_number('a', 4).alias('v')).collect()
    ..

[Row(v=’5.0000’)]

pyspark.sql.functions.encode pyspark.sql.functions.format_string