Help Center> Data Lake Insight> Spark SQL Syntax Reference> Built-In Functions> Other Functions> trunc_numeric
Updated on 2023-10-25 GMT+08:00
View PDF

trunc_numeric

This function is used to truncate the number value to a specified decimal place.

Syntax

trunc_numeric(<number>[, bigint<decimal_places>])

Parameters

Table 1 Parameters

Parameter

Mandatory

Type

Description

number

Yes

DOUBLE, BIGINT, DECIMAL, or STRING

Data to be truncated

decimal_places

No

BIGINT

The default value is 0, indicating that the decimal place at which the number is truncated.

Return Values

The return value is of the DOUBLE or DECIMAL type.

The return rules are as follows:

  • If the number value is of the DOUBLE or DECIMAL type, the corresponding type is returned.
  • If the number value is of the STRING or BIGINT type, DOUBLE is returned.
  • If the decimal_places value is not of the BIGINT type, an error is reported.
  • If the value of number is NULL, NULL is returned.

Example Code

The value 3.141 is returned.

select trunc_numeric(3.1415926, 3);

The value 3 is returned.

select trunc_numeric(3.1415926);

An error is reported.

select trunc_numeric(3.1415926, 3.1);
Parent topic: Other Functions