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_pos`INTThe result ofx-y`, saturating at 0 for the minimum bound

Found an issue on this page?

Report an issue!
Previoussaturating_subNextStatistical aggregates

Related Content

saturating_add
The saturating_add function adds two numbers, saturating at -2147483648 and 2147483647 instead of overflowing
saturating_mul
The saturating_mul function multiples two numbers, saturating at -2147483648 and 2147483647 instead of overflowing
saturating_add_pos
The saturating_add_pos function adds two numbers, saturating at 0 and 2147483647 instead of overflowing
saturating_sub
The saturating_sub function subtracts the second number from the first, saturating at -2147483648 and 2147483647 instead of overflowing