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/datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new f56a2ef28f doc: Add support for `map` and `make_map` functions (#11799)
f56a2ef28f is described below
commit f56a2ef28f669351d5faec23ca0a6edef5c53ee6
Author: Alex Huang <[email protected]>
AuthorDate: Tue Aug 6 00:21:04 2024 +0800
doc: Add support for `map` and `make_map` functions (#11799)
* doc: Add support for `map` and `make_map` functions
* chore: Add example for MAP
---
docs/source/user-guide/sql/scalar_functions.md | 64 ++++++++++++++++++++++++++
1 file changed, 64 insertions(+)
diff --git a/docs/source/user-guide/sql/scalar_functions.md
b/docs/source/user-guide/sql/scalar_functions.md
index 561824772a..c7490df049 100644
--- a/docs/source/user-guide/sql/scalar_functions.md
+++ b/docs/source/user-guide/sql/scalar_functions.md
@@ -3636,6 +3636,70 @@ Unwraps struct fields into columns.
+-----------------------+-----------------------+
```
+## Map Functions
+
+- [map](#map)
+- [make_map](#make_map)
+
+### `map`
+
+Returns an Arrow map with the specified key-value pairs.
+
+```
+map(key, value)
+map(key: value)
+```
+
+#### Arguments
+
+- **key**: Expression to be used for key.
+ Can be a constant, column, or function, any combination of arithmetic or
+ string operators, or a named expression of previous listed.
+- **value**: Expression to be used for value.
+ Can be a constant, column, or function, any combination of arithmetic or
+ string operators, or a named expression of previous listed.
+
+#### Example
+
+```
+SELECT MAP(['POST', 'HEAD', 'PATCH'], [41, 33, null]);
+----
+{POST: 41, HEAD: 33, PATCH: }
+
+SELECT MAP([[1,2], [3,4]], ['a', 'b']);
+----
+{[1, 2]: a, [3, 4]: b}
+
+SELECT MAP { 'a': 1, 'b': 2 };
+----
+{a: 1, b: 2}
+```
+
+### `make_map`
+
+Returns an Arrow map with the specified key-value pairs.
+
+```
+make_map(key_1, value_1, ..., key_n, value_n)
+```
+
+#### Arguments
+
+- **key_n**: Expression to be used for key.
+ Can be a constant, column, or function, any combination of arithmetic or
+ string operators, or a named expression of previous listed.
+- **value_n**: Expression to be used for value.
+ Can be a constant, column, or function, any combination of arithmetic or
+ string operators, or a named expression of previous listed.
+
+#### Example
+
+```
+SELECT MAKE_MAP('POST', 41, 'HEAD', 33, 'PATCH', null);
+----
+{POST: 41, HEAD: 33, PATCH: }
+```
+
## Hashing Functions
- [digest](#digest)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
