BITMAP_TO_BASE64
Descriptionβ
Converts a Bitmap into a Base64 encoded string.
Syntaxβ
BITMAP_TO_BASE64(<bitmap>)
Parametersβ
| Parameter | Description |
|---|---|
<bitmap> | A Bitmap type column or expression |
Return Valueβ
A Base64 encoded string of the Bitmap.
Returns NULL if the Bitmap is NULL.
::: note
The BE configuration option enable_set_in_bitmap_value changes the specific format of bitmap values in memory, which affects the result of this function.
Due to the non-guaranteed order of elements in a bitmap, the generated Base64 string may not always be the same for the same content. However, the decoded bitmap from bitmap_from_base64 will be the same.
:::
Examplesβ
To convert a NULL Bitmap to a Base64 string:
select bitmap_to_base64(null);
The result will be:
+------------------------+
| bitmap_to_base64(NULL) |
+------------------------+
| NULL |
+------------------------+
To convert an empty Bitmap to a Base64 string:
select bitmap_to_base64(bitmap_empty());
The result will be:
+----------------------------------+
| bitmap_to_base64(bitmap_empty()) |
+----------------------------------+
| AA== |
+----------------------------------+
To convert a Bitmap with a single element to a Base64 string:
select bitmap_to_base64(to_bitmap(1));
The result will be:
+--------------------------------+
| bitmap_to_base64(to_bitmap(1)) |
+--------------------------------+
| AQEAAAA= |
+--------------------------------+
To convert a Bitmap with multiple elements to a Base64 string:
select bitmap_to_base64(bitmap_from_string("1,9999999"));
The result will be:
+---------------------------------------------------------+
| bitmap_to_base64(bitmap_from_string("1,9999999")) |
+---------------------------------------------------------+
| AjowAAACAAAAAAAAAJgAAAAYAAAAGgAAAAEAf5Y= |
+---------------------------------------------------------+
