bit_get function

Applies to: Databricks SQL Databricks Runtime 11.3 LTS and above

Returns the value of a bit in a binary representation of an integral numeric. This function is a synonym for getbit function.

Syntax

bit_get(expr, pos))

Arguments

• expr: An expression that evaluates to an integral numeric.
• pos: An expression of type INTEGER.

Returns

The result type is an 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 Azure Databricks raises an INVALID_PARAMETER_VALUE error.

Common error conditions

• INVALID_PARAMETER_VALUE

Examples

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

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

> SELECT bit_get(23Y, 8);
 Error: INVALID_PARAMETER_VALUE.BIT_POSITION_RANGE

> SELECT bit_get(23Y, -1);
 Error: INVALID_PARAMETER_VALUE.BIT_POSITION_RANGE

Related functions

• bit_reverse function
• getbit function
• ~ (tilde sign) operator