format_units

Scalar function

Scales raw EVM integer balances by 10^decimals and returns a VARCHAR string representation.

Overloads

format_units(UINT256)
format_units(UINT256, INTEGER)
format_units(UINT256, UTINYINT)
format_units(UINT256, UINT8)
format_units(INT256)
format_units(INT256, INTEGER)
format_units(INT256, UTINYINT)
format_units(INT256, UINT8)
format_units(UTINYINT)
format_units(UTINYINT, INTEGER)
format_units(UTINYINT, UTINYINT)
format_units(UTINYINT, UINT8)
format_units(USMALLINT)
format_units(USMALLINT, INTEGER)
format_units(USMALLINT, UTINYINT)
format_units(USMALLINT, UINT8)
format_units(UINTEGER)
format_units(UINTEGER, INTEGER)
format_units(UINTEGER, UTINYINT)
format_units(UINTEGER, UINT8)
format_units(UBIGINT)
format_units(UBIGINT, INTEGER)
format_units(UBIGINT, UTINYINT)
format_units(UBIGINT, UINT8)
format_units(UHUGEINT)
format_units(UHUGEINT, INTEGER)
format_units(UHUGEINT, UTINYINT)
format_units(UHUGEINT, UINT8)
format_units(TINYINT)
format_units(TINYINT, INTEGER)
format_units(TINYINT, UTINYINT)
format_units(TINYINT, UINT8)
format_units(SMALLINT)
format_units(SMALLINT, INTEGER)
format_units(SMALLINT, UTINYINT)
format_units(SMALLINT, UINT8)
format_units(INTEGER)
format_units(INTEGER, INTEGER)
format_units(INTEGER, UTINYINT)
format_units(INTEGER, UINT8)
format_units(BIGINT)
format_units(BIGINT, INTEGER)
format_units(BIGINT, UTINYINT)
format_units(BIGINT, UINT8)
format_units(HUGEINT)
format_units(HUGEINT, INTEGER)
format_units(HUGEINT, UTINYINT)
format_units(HUGEINT, UINT8)

format_units(UINT256)

Assumes an 18-decimal asset (ETH-style) and formats UINT256 values into human decimals.

Parameters

Name	Type
raw_amount	UINT256

Returns

Name	Type
formatted_value	VARCHAR

SELECT format_units('0xde0b6b3a7640000'::uint256); -- 1 ETH

Enable JavaScript to run this sample in the notebook. The SQL preview above is still available for reference.

format_units(UINT256, INTEGER)

Format arbitrary ERC-20 style UINT256 balances by specifying the on-chain decimals.

Parameters

Name	Type
raw_amount	UINT256
decimals	INTEGER

Returns

Name	Type
formatted_value	VARCHAR

SELECT format_units(123000000::uint256, 6); -- 123.000000 USDC

Enable JavaScript to run this sample in the notebook. The SQL preview above is still available for reference.

format_units(UINT256, UTINYINT)

Same as the UINT overload but for signed INT256 feeds (e.g., Chainlink oracles).

Parameters

Name	Type
raw_amount	UINT256
arg2	UTINYINT

Returns

Name	Type
formatted_value	VARCHAR

SELECT format_units(('0x0de0b6b3a7640000')::int256);

Enable JavaScript to run this sample in the notebook. The SQL preview above is still available for reference.

format_units(UINT256, UINT8)

Signed INT256 variant with caller-provided decimal precision.

Parameters

Name	Type
raw_amount	UINT256
decimals	UINT8

Returns

Name	Type
formatted_value	VARCHAR

SELECT format_units(('0x3b9aca00')::int256, 8);

Enable JavaScript to run this sample in the notebook. The SQL preview above is still available for reference.

format_units(INT256)

Format native integer types (TINYINT through HUGEINT, signed and unsigned).

Parameters

Name	Type
raw_amount	INT256

Returns

Name	Type
formatted_value	VARCHAR

SELECT format_units(1000000::UBIGINT, 6); -- 1.000000

Enable JavaScript to run this sample in the notebook. The SQL preview above is still available for reference.

format_units(INT256, INTEGER)

Format native integer types with custom decimal precision.

Parameters

Name	Type
raw_amount	INT256
decimals	INTEGER

Returns

Name	Type
formatted_value	VARCHAR

SELECT format_units(255::UTINYINT, 2); -- 2.55

Enable JavaScript to run this sample in the notebook. The SQL preview above is still available for reference.

format_units(INT256, UTINYINT)

Parameters

Name	Type
arg1	INT256
arg2	UTINYINT

Returns

Name	Type
result	VARCHAR

format_units(INT256, UINT8)

Parameters

Name	Type
arg1	INT256
arg2	UINT8

Returns

Name	Type
result	VARCHAR

format_units(UTINYINT)

Parameters

Name	Type
arg1	UTINYINT

Returns

Name	Type
result	VARCHAR

format_units(UTINYINT, INTEGER)

Parameters

Name	Type
arg1	UTINYINT
arg2	INTEGER

Returns

Name	Type
result	VARCHAR

format_units(UTINYINT, UTINYINT)

Parameters

Name	Type
arg1	UTINYINT
arg2	UTINYINT

Returns

Name	Type
result	VARCHAR

format_units(UTINYINT, UINT8)

Parameters

Name	Type
arg1	UTINYINT
arg2	UINT8

Returns

Name	Type
result	VARCHAR

format_units(USMALLINT)

Parameters

Name	Type
arg1	USMALLINT

Returns

Name	Type
result	VARCHAR

format_units(USMALLINT, INTEGER)

Parameters

Name	Type
arg1	USMALLINT
arg2	INTEGER

Returns

Name	Type
result	VARCHAR

format_units(USMALLINT, UTINYINT)

Parameters

Name	Type
arg1	USMALLINT
arg2	UTINYINT

Returns

Name	Type
result	VARCHAR

format_units(USMALLINT, UINT8)

Parameters

Name	Type
arg1	USMALLINT
arg2	UINT8

Returns

Name	Type
result	VARCHAR

format_units(UINTEGER)

Parameters

Name	Type
arg1	UINTEGER

Returns

Name	Type
result	VARCHAR

format_units(UINTEGER, INTEGER)

Parameters

Name	Type
arg1	UINTEGER
arg2	INTEGER

Returns

Name	Type
result	VARCHAR

format_units(UINTEGER, UTINYINT)

Parameters

Name	Type
arg1	UINTEGER
arg2	UTINYINT

Returns

Name	Type
result	VARCHAR

format_units(UINTEGER, UINT8)

Parameters

Name	Type
arg1	UINTEGER
arg2	UINT8

Returns

Name	Type
result	VARCHAR

format_units(UBIGINT)

Parameters

Name	Type
arg1	UBIGINT

Returns

Name	Type
result	VARCHAR

format_units(UBIGINT, INTEGER)

Parameters

Name	Type
arg1	UBIGINT
arg2	INTEGER

Returns

Name	Type
result	VARCHAR

format_units(UBIGINT, UTINYINT)

Parameters

Name	Type
arg1	UBIGINT
arg2	UTINYINT

Returns

Name	Type
result	VARCHAR

format_units(UBIGINT, UINT8)

Parameters

Name	Type
arg1	UBIGINT
arg2	UINT8

Returns

Name	Type
result	VARCHAR

format_units(UHUGEINT)

Parameters

Name	Type
arg1	UHUGEINT

Returns

Name	Type
result	VARCHAR

format_units(UHUGEINT, INTEGER)

Parameters

Name	Type
arg1	UHUGEINT
arg2	INTEGER

Returns

Name	Type
result	VARCHAR

format_units(UHUGEINT, UTINYINT)

Parameters

Name	Type
arg1	UHUGEINT
arg2	UTINYINT

Returns

Name	Type
result	VARCHAR

format_units(UHUGEINT, UINT8)

Parameters

Name	Type
arg1	UHUGEINT
arg2	UINT8

Returns

Name	Type
result	VARCHAR

format_units(TINYINT)

Parameters

Name	Type
arg1	TINYINT

Returns

Name	Type
result	VARCHAR

format_units(TINYINT, INTEGER)

Parameters

Name	Type
arg1	TINYINT
arg2	INTEGER

Returns

Name	Type
result	VARCHAR

format_units(TINYINT, UTINYINT)

Parameters

Name	Type
arg1	TINYINT
arg2	UTINYINT

Returns

Name	Type
result	VARCHAR

format_units(TINYINT, UINT8)

Parameters

Name	Type
arg1	TINYINT
arg2	UINT8

Returns

Name	Type
result	VARCHAR

format_units(SMALLINT)

Parameters

Name	Type
arg1	SMALLINT

Returns

Name	Type
result	VARCHAR

format_units(SMALLINT, INTEGER)

Parameters

Name	Type
arg1	SMALLINT
arg2	INTEGER

Returns

Name	Type
result	VARCHAR

format_units(SMALLINT, UTINYINT)

Parameters

Name	Type
arg1	SMALLINT
arg2	UTINYINT

Returns

Name	Type
result	VARCHAR

format_units(SMALLINT, UINT8)

Parameters

Name	Type
arg1	SMALLINT
arg2	UINT8

Returns

Name	Type
result	VARCHAR

format_units(INTEGER)

Parameters

Name	Type
arg1	INTEGER

Returns

Name	Type
result	VARCHAR

format_units(INTEGER, INTEGER)

Parameters

Name	Type
arg1	INTEGER
arg2	INTEGER

Returns

Name	Type
result	VARCHAR

format_units(INTEGER, UTINYINT)

Parameters

Name	Type
arg1	INTEGER
arg2	UTINYINT

Returns

Name	Type
result	VARCHAR

format_units(INTEGER, UINT8)

Parameters

Name	Type
arg1	INTEGER
arg2	UINT8

Returns

Name	Type
result	VARCHAR

format_units(BIGINT)

Parameters

Name	Type
arg1	BIGINT

Returns

Name	Type
result	VARCHAR

format_units(BIGINT, INTEGER)

Parameters

Name	Type
arg1	BIGINT
arg2	INTEGER

Returns

Name	Type
result	VARCHAR

format_units(BIGINT, UTINYINT)

Parameters

Name	Type
arg1	BIGINT
arg2	UTINYINT

Returns

Name	Type
result	VARCHAR

format_units(BIGINT, UINT8)

Parameters

Name	Type
arg1	BIGINT
arg2	UINT8

Returns

Name	Type
result	VARCHAR

format_units(HUGEINT)

Parameters

Name	Type
arg1	HUGEINT

Returns

Name	Type
result	VARCHAR

format_units(HUGEINT, INTEGER)

Parameters

Name	Type
arg1	HUGEINT
arg2	INTEGER

Returns

Name	Type
result	VARCHAR

format_units(HUGEINT, UTINYINT)

Parameters

Name	Type
arg1	HUGEINT
arg2	UTINYINT

Returns

Name	Type
result	VARCHAR

format_units(HUGEINT, UINT8)

Parameters

Name	Type
arg1	HUGEINT
arg2	UINT8

Returns

Name	Type
result	VARCHAR