---

{ “title”: “EXPLODE_BITMAP_OUTER”, “language”: “en”, “description”: “The explodebitmapouter table function accepts a bitmap type data and maps each bit in the bitmap to a separate row.” }

Description

The explode_bitmap_outer table function accepts a bitmap type data and maps each bit in the bitmap to a separate row. It is commonly used to process bitmap data, expanding each element in the bitmap into a separate record. It should be used together with LATERAL VIEW. explode_bitmap_outer is similar to explode_bitmap, but behaves differently when handling empty or NULL values. It allows records with empty or NULL bitmaps to exist and expands them into NULL rows in the result.

Syntax

EXPLODE_BITMAP_OUTER(<bitmap>)

Parameters

• <bitmap> BITMAP type

Return Value

• Returns a row for each bit in <bitmap>, with each row containing a bit value.
• If <bitmap> is NULL, 1 row with NULL is returned.
• If <bitmap> is empty, 1 row with NULL is returned.

Usage Notes

1. If the <bitmap> parameter is not of type BITMAP, an error will be reported.

Examples

0. Prepare data

   create table example(
       k1 int
   ) properties(
       "replication_num" = "1"
   );
   
   insert into example values(1);
   

1. Regular parameters

   select k1, e1 from example lateral view explode_bitmap_outer(bitmap_from_string("1,3,4,5,6,10")) t2 as e1 order by k1, e1;
   

   +------+------+
   | k1   | e1   |
   +------+------+
   |    1 |    1 |
   |    1 |    3 |
   |    1 |    4 |
   |    1 |    5 |
   |    1 |    6 |
   |    1 |   10 |
   +------+------+
   

2. Empty BITMAP

   select k1, e1 from example lateral view explode_bitmap_outer(bitmap_from_string("")) t2 as e1 order by k1, e1;
   

   +------+------+
   | k1   | e1   |
   +------+------+
   |    1 | NULL |
   +------+------+
   

3. NULL parameter

   select  * from example lateral view explode_bitmap_outer(NULL) t2 as c;
   

   +------+------+
   | k1   | e1   |
   +------+------+
   |    1 | NULL |
   +------+------+
   

4. Non-array parameter

   select  * from example lateral view explode_bitmap_outer('abc') t2 as c;
   

   ERROR 1105 (HY000): errCode = 2, detailMessage = Can not find the compatibility function signature: explode_bitmap_outer(VARCHAR(3))