getbit function (Databricks SQL)

Returns the value of a bit in a binary representation of an integral numeric.

Syntax

getbit(expr, pos))

Arguments

  • expr: An expression that evaluates to an integral numeric.

  • pos: An expression of type INTEGER.

Returns

The result type is INTEGER.

The result value is 1 if the bit is set, 0 otherwise.

Bits are counted right to left and 0-based.

If pos is outside the bounds of the data type of expr Databricks SQL raises an error.

getbit is a synonym of bit_get.

Examples

> SELECT hex(23Y), getbit(23Y, 3);
 0

> SELECT hex(23Y), getbit(23Y, 0);
 1

> SELECT getbit(23Y, 8);
 Invalid bit position: 8 exceeds the bit upper limit

> SELECT getbit(23Y, -1);
 Invalid bit position: -1 is less than zero