API ReferenceHyperfunctionsSaturating mathsaturating_sub_pos
Versions:

saturating_sub_pos()
Toolkit
TimescaleDB Toolkit functions are available under Timescale Community Edition. They are automatically included with Timescale Cloud. Click to learn more.
Experimental
Experimental TimescaleDB Toolkit functions are not suitable for production environments. They may have bugs and may cause data loss. Click to learn more.

The saturating_sub_pos subtracts the second number from the first, saturating at 0 and 2147483647 instead of overflowing.

For more information about saturating math functions, see the saturating math docs.

Required arguments

NameTypeDescription
xINTAn integer for y to subtract from
yINTAn integer to subtract from x

Returns

ColumnTypeDescription
saturating_sub_posINTThe result of x-y, saturating at 0 for the minimum bound

Found an issue on this page?

Report an issue!
Previoussaturating_subNextstats_agg (one variable)

Related Content

Saturating math
Perform saturating math on integers to keep results within bounds
saturating_add()
Adds two numbers, saturating at the numeric bounds instead of overflowing
saturating_mul()
Multiples two numbers, saturating at the numeric bounds instead of overflowing
saturating_sub()
Subtracts one number from another, saturating at the numeric bounds instead of overflowing
saturating_add_pos()
Adds two numbers, saturating at 0 for the minimum bound
Hyperfunctions
Use hyperfunctions to simplify data analysis