This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new f12f51595e docs: Add `encode` and `decode` to the user guide (#6856)
f12f51595e is described below
commit f12f51595e06d5ec868ef7b007d220b9c4113bfd
Author: Andrew Lamb <and...@nerdnetworks.org>
AuthorDate: Fri Jul 7 04:02:45 2023 -0400
docs: Add `encode` and `decode` to the user guide (#6856)
---
docs/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 34999ddf16..58d0dd253e 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
