[GitHub] [flink] MartijnVisser commented on a change in pull request #18251: [FLINK-25488][table] Clarify delimiters usage in STR_TO_MAP function

[GitBox <gi...@apache.org>]

MartijnVisser commented on a change in pull request #18251:
URL: https://github.com/apache/flink/pull/18251#discussion_r777500809



##########
File path: docs/data/sql_functions.yml
##########
@@ -357,8 +357,10 @@ string:
     description: Returns the reversed string. Returns NULL if string is NULL.
   - sql: SPLIT_INDEX(string1, string2, integer1)
     description: Splits string1 by the delimiter string2, returns the integerth (zero-based) string of the split strings. Returns NULL if integer is negative. Returns NULL if any of arguments is NULL.
-  - sql: STR_TO_MAP(string1[, string2, string3]])
-    description: Returns a map after splitting the string1 into key/value pairs using delimiters. string2 is the pair delimiter, default is ','. And string3 is the key-value delimiter, default is '='.
+  - sql: STR_TO_MAP(string1[, string2, string3])
+    description: |
+      Returns a map after splitting the string1 into key/value pairs using delimiters. string2 is the pair delimiter, default is ','. And string3 is the key-value delimiter, default is '='.
+      Both pair delimiter and key-value delimiter are treated as regular expressions.

Review comment:
       I think it makes sense to mention that, for example, if you want to use a pipe symbol as a delimiter, this means that you need to escape this character? 




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org