From 1970cebcb724842984ff0aa7eaee160dd904135d Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Wed, 5 Jul 2023 13:18:30 -0400 Subject: [PATCH] docs: Add `encode` and `decode` to the user guide --- .../source/user-guide/sql/scalar_functions.md | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/docs/source/user-guide/sql/scalar_functions.md b/docs/source/user-guide/sql/scalar_functions.md index 34999ddf168b..58d0dd253e64 100644 --- a/docs/source/user-guide/sql/scalar_functions.md +++ b/docs/source/user-guide/sql/scalar_functions.md @@ -1070,6 +1070,45 @@ Returns UUID v4 string value which is unique per row. uuid() ``` +## Binary String Functions + +- [decode](#decode) +- [encode](#encode) + +### `encode` + +Encode binary data into a textual representation. + +``` +encode(expression, format) +``` + +#### Arguments + +- **expression**: Expression containing string or binary data + +- **format**: Supported formats are: `base64`, `hex` + +**Related functions**: +[decode](#decode) + +### `decode` + +Decode binary data from textual representation in string. + +``` +decode(expression, format) +``` + +#### Arguments + +- **expression**: Expression containing encoded string data + +- **format**: Same arguments as [encode](#encode) + +**Related functions**: +[encode](#encode) + ## Regular Expression Functions Apache DataFusion uses the POSIX regular expression syntax and