Skip to content

Latest commit

 

History

History
310 lines (241 loc) · 11.6 KB

bit-functions-and-operators.md

File metadata and controls

310 lines (241 loc) · 11.6 KB
Raw
title summary aliases
Bit Functions and Operators
Learn about the bit functions and operators.
/docs/dev/functions-and-operators/bit-functions-and-operators/
/docs/dev/reference/sql/functions-and-operators/bit-functions-and-operators/

Bit Functions and Operators

TiDB supports all of the bit functions and operators available in MySQL 8.0.

Bit functions and operators:

Name Description
BIT_COUNT() Return the number of bits that are set as 1
& Bitwise AND
~ Bitwise inversion
| Bitwise OR
^ Bitwise XOR
<< Left shift
>> Right shift

BIT_COUNT()

The BIT_COUNT(expr) function returns the number of bits that are set as 1 in expr.

SELECT BIT_COUNT(b'00101001');
+------------------------+
| BIT_COUNT(b'00101001') |
+------------------------+
|                      3 |
+------------------------+
1 row in set (0.00 sec)

Note:

If the argument expr is a binary number, you need to specify b explicitly before the number, such as b'00101001'. Otherwise, this function treats it as a string and returns a different result. For example, BIT_COUNT('00101001') returns 7 because it converts the string '00101001' as the decimal number 101001 and counts the number of 1 bits in its binary format 11000100001010001.

The following example is similar to the preceding one, but it uses a hex-literal instead of a bit-literal as the argument. The CONV() function converts 0x29 from hexadecimal (base 16) to binary (base 2), showing that it equals 00101001 in binary.

SELECT BIT_COUNT(0x29), CONV(0x29,16,2);
+-----------------+-----------------+
| BIT_COUNT(0x29) | CONV(0x29,16,2) |
+-----------------+-----------------+
|               3 | 101001          |
+-----------------+-----------------+
1 row in set (0.01 sec)

A practical use of the BIT_COUNT(expr) function is to convert a netmask to a CIDR notation. In the following example, the netmask 255.255.255.0 is converted to its CIDR representation 24.

SELECT BIT_COUNT(INET_ATON('255.255.255.0'));
+---------------------------------------+
| BIT_COUNT(INET_ATON('255.255.255.0')) |
+---------------------------------------+
|                                    24 |
+---------------------------------------+
1 row in set (0.00 sec)

& (bitwise AND)

The & operator performs a bitwise AND operation. It compares the corresponding bits of two numbers: if both corresponding bits are 1, the corresponding bit of the result is 1; otherwise, it is 0.

For example, a bitwise AND operation between 1010 and 1100 returns 1000, because only the leftmost bit is set as 1 in both numbers.

  1010
& 1100
  ----
  1000

In SQL, you can use the & operator as follows:

SELECT CONV(b'1010' & b'1000',10,2);
+------------------------------+
| CONV(b'1010' & b'1000',10,2) |
+------------------------------+
| 1000                         |
+------------------------------+
1 row in set (0.00 sec)

You can use the & operator with INET_NTOA() and INET_ATON() functions to perform a bitwise AND operation on an IP address and a network mask to get the network address. This is useful to determine whether multiple IP addresses belong to the same network or not.

In the following two examples, the IP addresses 192.168.1.1 and 192.168.1.2 are in the same network 192.168.1.0/24 when masked with 255.255.255.0.

SELECT INET_NTOA(INET_ATON('192.168.1.1') & INET_ATON('255.255.255.0'));
+------------------------------------------------------------------+
| INET_NTOA(INET_ATON('192.168.1.1') & INET_ATON('255.255.255.0')) |
+------------------------------------------------------------------+
| 192.168.1.0                                                      |
+------------------------------------------------------------------+
1 row in set (0.00 sec)

SELECT INET_NTOA(INET_ATON('192.168.1.2') & INET_ATON('255.255.255.0'));
+------------------------------------------------------------------+
| INET_NTOA(INET_ATON('192.168.1.2') & INET_ATON('255.255.255.0')) |
+------------------------------------------------------------------+
| 192.168.1.0                                                      |
+------------------------------------------------------------------+
1 row in set (0.00 sec)

~ (bitwise inversion)

The ~ operator performs a bitwise inversion (or bitwise NOT) operation on a given value. It inverts each bit of the given value: bits that are 0 become 1, and bits that are 1 become 0.

Before the operation, the value is expanded to 64 bits.

Take the binary number 1111000011110000 as an example. When expanded to 64 bits and inverted, it looks like this:

Original (16 bits):                                                                 1111000011110000
Expanded and inverted (64 bits):    1111111111111111111111111111111111111111111111110000111100001111

In SQL, you can use the ~ operator as follows:

SELECT CONV(~ b'1111000011110000',10,2);
+------------------------------------------------------------------+
| CONV(~ b'1111000011110000',10,2)                                 |
+------------------------------------------------------------------+
| 1111111111111111111111111111111111111111111111110000111100001111 |
+------------------------------------------------------------------+
1 row in set (0.00 sec)

You can reverse the inversion by applying the ~ operator again to the result:

SELECT CONV(~ b'1111111111111111111111111111111111111111111111110000111100001111',10,2);
+----------------------------------------------------------------------------------+
| CONV(~ b'1111111111111111111111111111111111111111111111110000111100001111',10,2) |
+----------------------------------------------------------------------------------+
| 1111000011110000                                                                 |
+----------------------------------------------------------------------------------+
1 row in set (0.00 sec)

| (bitwise OR)

The | operator performs a bitwise OR operation. It compares the corresponding bits of two numbers: if at least one of the corresponding bits is 1, the corresponding bit in the result is 1.

For example, a bitwise OR operation between 1010 and 1100 returns 1110, because among the first three bits of the two numbers, at least one of the corresponding bits is set as 1.

  1010
| 1100
  ----
  1110

In SQL, you can use the | operator as follows:

SELECT CONV(b'1010' | b'1100',10,2);
+------------------------------+
| CONV(b'1010' | b'1100',10,2) |
+------------------------------+
| 1110                         |
+------------------------------+
1 row in set (0.00 sec)

^ (bitwise XOR)

The ^ operator performs a bitwise XOR (exclusive OR) operation. It compares the corresponding bits of two numbers: if the corresponding bits are different, the corresponding bit in the result is 1.

For example, a bitwise XOR operation between 1010 and 1100 returns 0110, because the second and the third bits of the two numbers are different.

  1010
^ 1100
  ----
  0110

In SQL, you can use the ^ operator as follows:

SELECT CONV(b'1010' ^ b'1100',10,2);
+------------------------------+
| CONV(b'1010' ^ b'1100',10,2) |
+------------------------------+
| 110                          |
+------------------------------+
1 row in set (0.00 sec)

Note that the result is shown as 110 instead of 0110 because the leading zero is removed.

<< (left shift)

The << operator performs a left shift operation, which shifts the bits of a number to the left by a specified number of positions, filling the vacated bits with zeros on the right.

For example, the following statement uses 1<<n to shift the binary value 1 to the left by n positions:

WITH RECURSIVE cte(n) AS (
    SELECT 0 AS n
    UNION ALL
    SELECT 1+n FROM cte WHERE n<10
)
SELECT n,1<<n,LPAD(CONV(1<<n,10,2),11,0) FROM cte;
+------+------+----------------------------+
| n    | 1<<n | LPAD(CONV(1<<n,10,2),11,0) |
+------+------+----------------------------+
|    0 |    1 | 00000000001                |
|    1 |    2 | 00000000010                |
|    2 |    4 | 00000000100                |
|    3 |    8 | 00000001000                |
|    4 |   16 | 00000010000                |
|    5 |   32 | 00000100000                |
|    6 |   64 | 00001000000                |
|    7 |  128 | 00010000000                |
|    8 |  256 | 00100000000                |
|    9 |  512 | 01000000000                |
|   10 | 1024 | 10000000000                |
+------+------+----------------------------+
11 rows in set (0.00 sec)

>> (right shift)

The >> operator performs a right shift operation, which shifts the bits of a number to the right by a specified number of positions, filling the vacated bits with zeros on the left.

For example, the following statement uses 1024>>n to shift a value of 1024 (10000000000 in binary) to the right by n positions:

WITH RECURSIVE cte(n) AS (
    SELECT 0 AS n
    UNION ALL
    SELECT n+1 FROM cte WHERE n<11
)
SELECT n,1024>>n,LPAD(CONV(1024>>n,10,2),11,0) FROM cte;
+------+---------+-------------------------------+
| n    | 1024>>n | LPAD(CONV(1024>>n,10,2),11,0) |
+------+---------+-------------------------------+
|    0 |    1024 | 10000000000                   |
|    1 |     512 | 01000000000                   |
|    2 |     256 | 00100000000                   |
|    3 |     128 | 00010000000                   |
|    4 |      64 | 00001000000                   |
|    5 |      32 | 00000100000                   |
|    6 |      16 | 00000010000                   |
|    7 |       8 | 00000001000                   |
|    8 |       4 | 00000000100                   |
|    9 |       2 | 00000000010                   |
|   10 |       1 | 00000000001                   |
|   11 |       0 | 00000000000                   |
+------+---------+-------------------------------+
12 rows in set (0.00 sec)

The >> operator can also be useful for extracting specific parts of a larger number, such as extracting a UNIX timestamp from a TiDB TSO timestamp.

MySQL compatibility

There are some differences between MySQL 8.0 and earlier versions of MySQL in handling bit functions and operators. TiDB aims to follow the behavior of MySQL 8.0.

Known issues

In the following cases, the query results in TiDB are the same as MySQL 5.7 but different from MySQL 8.0.

  • Bitwise operations with binary arguments. For more information, see #30637.
  • The result of the BIT_COUNT() function. For more information, see #44621.