You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "gustavodemorais (via GitHub)" <gi...@apache.org> on 2025/02/24 09:33:01 UTC

[PR] [FLINK-37374][table] Add the built-in function JSON for JSON_OBJECT [flink]

gustavodemorais opened a new pull request, #26199:
URL: https://github.com/apache/flink/pull/26199

   <!--
   *Thank you very much for contributing to Apache Flink - we are happy that you want to help us improve Flink. To help the community review your contribution in the best possible way, please go through the checklist below, which will get the contribution into a shape in which it can be best reviewed.*
   
   *Please understand that we do not do this to make contributions to Flink a hassle. In order to uphold a high standard of quality for code contributions, while at the same time managing a large number of contributions, we need contributors to prepare the contributions well, and give reviewers enough contextual information for the review. Please also understand that contributions that do not follow this guide will take longer to review and thus typically be picked up with lower priority by the community.*
   
   ## Contribution Checklist
   
     - Make sure that the pull request corresponds to a [JIRA issue](https://issues.apache.org/jira/projects/FLINK/issues). Exceptions are made for typos in JavaDoc or documentation files, which need no JIRA issue.
     
     - Name the pull request in the form "[FLINK-XXXX] [component] Title of the pull request", where *FLINK-XXXX* should be replaced by the actual issue number. Skip *component* if you are unsure about which is the best component.
     Typo fixes that have no associated JIRA issue should be named following this pattern: `[hotfix] [docs] Fix typo in event time introduction` or `[hotfix] [javadocs] Expand JavaDoc for PuncuatedWatermarkGenerator`.
   
     - Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
     
     - Make sure that the change passes the automated tests, i.e., `mvn clean verify` passes. You can set up Azure Pipelines CI to do that following [this guide](https://cwiki.apache.org/confluence/display/FLINK/Azure+Pipelines#AzurePipelines-Tutorial:SettingupAzurePipelinesforaforkoftheFlinkrepository).
   
     - Each pull request should address only one issue, not mix up code from multiple issues.
     
     - Each commit in the pull request has a meaningful commit message (including the JIRA id)
   
     - Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
   
   
   **(The sections below can be removed for hotfixes of typos)**
   -->
   
   ## What is the purpose of the change
   
   It is currently not possible to declare a SQL string that contains existing JSON as valid JSON for JSON_ARRAY.  
   
   We already added support for JSON inside JSON_OBJECT and now want to support it the same way for JSON_ARRAY, which is another building block for JSON in Flink. See JSON_OBJECT PR: https://github.com/apache/flink/pull/26022
   
   Example:
   ```
   jsonArray(json('{"value": 42}'))
   JSON_ARRAY(JSON('{"value": 42}'))
   // [{"value":42}]
   ```
   
   ## Brief change log
   
     - *Update code to enable calling json in json_array*
     - *Update expression reductior to accomodate json* 
     - *Add tests for json function in json array*
     - *Docs*
   
   
   ## Verifying this change
   
   This change added tests for multiple uses cases of the function.
   
   ## Does this pull request potentially affect one of the following parts:
   
     - Dependencies (does it add or upgrade a dependency): no
     - The public API, i.e., is any changed class annotated with `@Public(Evolving)`: yes
     - The serializers: no
     - The runtime per-record code paths (performance sensitive): no
     - Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
     - The S3 file system connector: no
   
   ## Documentation
   
     - Does this pull request introduce a new feature? yes
     - If yes, how is the feature documented? docs, JavaDocs
   


-- 
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


Re: [PR] [FLINK-37374][table] Add the built-in function JSON for JSON_ARRAY [flink]

Posted by "gustavodemorais (via GitHub)" <gi...@apache.org>.
gustavodemorais commented on code in PR #26199:
URL: https://github.com/apache/flink/pull/26199#discussion_r1971229099


##########
docs/data/sql_functions.yml:
##########
@@ -1098,6 +1099,15 @@ json:
 
       -- {"K": null}
       JSON_OBJECT('K' VALUE JSON(''))
+      
+      -- [{"K2":42}]
+      JSON_ARRAY(JSON('{"K2": 42}'))
+
+      -- [{"K2":{"K3":42}}]
+      JSON_ARRAY(JSON('{"K2":{"K3":42}}'))

Review Comment:
   Hey David, I've addressed your concern 👍 



-- 
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


Re: [PR] [FLINK-37374][table] Add the built-in function JSON for JSON_ARRAY [flink]

Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #26199:
URL: https://github.com/apache/flink/pull/26199#discussion_r1969505434


##########
docs/data/sql_functions.yml:
##########
@@ -1098,6 +1099,15 @@ json:
 
       -- {"K": null}
       JSON_OBJECT('K' VALUE JSON(''))
+      
+      -- [{"K2":42}]
+      JSON_ARRAY(JSON('{"K2": 42}'))
+
+      -- [{"K2":{"K3":42}}]
+      JSON_ARRAY(JSON('{"K2":{"K3":42}}'))

Review Comment:
   I think it would be good to give an example with more than one element 



-- 
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


Re: [PR] [FLINK-37374][table] Add the built-in function JSON for JSON_ARRAY [flink]

Posted by "dawidwys (via GitHub)" <gi...@apache.org>.
dawidwys commented on code in PR #26199:
URL: https://github.com/apache/flink/pull/26199#discussion_r1967382597


##########
flink-table/flink-table-planner/src/test/java/org/apache/flink/table/planner/functions/JsonFunctionsITCase.java:
##########
@@ -782,14 +783,95 @@ private static List<TestSetSpec> jsonSpec() {
                         .testTableApiRuntimeError(
                                 jsonObject(JsonOnNull.NULL, "K", json("{")),
                                 TableRuntimeException.class,
+                                "Invalid JSON string in JSON(value) function: \"{\". Error: org.apache.flink.shaded.jackson2.com.fasterxml.jackson.core.io.JsonEOFException: Unexpected end-of-input: expected close marker for Object (start marker at [Source: (String)\"{\"; line: 1, column: 1])\n"

Review Comment:
   Is the entire string necessary? Could we test for `Invalid JSON string in JSON(value) function` only? The rest of the message is rather fragile and can easily change.



##########
flink-table/flink-table-planner/src/main/scala/org/apache/flink/table/planner/codegen/JsonGenerateUtils.scala:
##########
@@ -186,6 +185,18 @@ object JsonGenerateUtils {
     }
   }
 
+  /** Determines whether the given operand is a call to a JSON_OBJECT */

Review Comment:
   ```suggestion
     /** Determines whether the given operand is a call to a JSON_ARRAY */
   ```



-- 
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


Re: [PR] [FLINK-37374][table] Add the built-in function JSON for JSON_ARRAY [flink]

Posted by "gustavodemorais (via GitHub)" <gi...@apache.org>.
gustavodemorais commented on PR #26199:
URL: https://github.com/apache/flink/pull/26199#issuecomment-2684342682

   > @gustavodemorais Do you mind rebasing? I was waiting for a green CI and then there is a conflict.
   
   Yep, will do it


-- 
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


Re: [PR] [FLINK-37374][table] Add the built-in function JSON for JSON_ARRAY [flink]

Posted by "dawidwys (via GitHub)" <gi...@apache.org>.
dawidwys commented on PR #26199:
URL: https://github.com/apache/flink/pull/26199#issuecomment-2684244640

   @gustavodemorais Do you mind rebasing? I was waiting for a green CI and then there is a conflict.


-- 
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


Re: [PR] [FLINK-37374][table] Add the built-in function JSON for JSON_OBJECT [flink]

Posted by "flinkbot (via GitHub)" <gi...@apache.org>.
flinkbot commented on PR #26199:
URL: https://github.com/apache/flink/pull/26199#issuecomment-2677981640

   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "8b9dd6f9a110e2dae0508e205ca9c94eacd7f5a8",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "8b9dd6f9a110e2dae0508e205ca9c94eacd7f5a8",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 8b9dd6f9a110e2dae0508e205ca9c94eacd7f5a8 UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run azure` re-run the last Azure build
   </details>


-- 
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


Re: [PR] [FLINK-37374][table] Add the built-in function JSON for JSON_ARRAY [flink]

Posted by "gustavodemorais (via GitHub)" <gi...@apache.org>.
gustavodemorais commented on code in PR #26199:
URL: https://github.com/apache/flink/pull/26199#discussion_r1968533783


##########
flink-table/flink-table-planner/src/test/java/org/apache/flink/table/planner/functions/JsonFunctionsITCase.java:
##########
@@ -782,14 +783,95 @@ private static List<TestSetSpec> jsonSpec() {
                         .testTableApiRuntimeError(
                                 jsonObject(JsonOnNull.NULL, "K", json("{")),
                                 TableRuntimeException.class,
+                                "Invalid JSON string in JSON(value) function: \"{\". Error: org.apache.flink.shaded.jackson2.com.fasterxml.jackson.core.io.JsonEOFException: Unexpected end-of-input: expected close marker for Object (start marker at [Source: (String)\"{\"; line: 1, column: 1])\n"

Review Comment:
   You actually have a good point and that's a good shout. Adjusted the tests 🙂



-- 
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


Re: [PR] [FLINK-37374][table] Add the built-in function JSON for JSON_ARRAY [flink]

Posted by "dawidwys (via GitHub)" <gi...@apache.org>.
dawidwys merged PR #26199:
URL: https://github.com/apache/flink/pull/26199


-- 
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


Re: [PR] [FLINK-37374][table] Add the built-in function JSON for JSON_ARRAY [flink]

Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #26199:
URL: https://github.com/apache/flink/pull/26199#discussion_r1969505434


##########
docs/data/sql_functions.yml:
##########
@@ -1098,6 +1099,15 @@ json:
 
       -- {"K": null}
       JSON_OBJECT('K' VALUE JSON(''))
+      
+      -- [{"K2":42}]
+      JSON_ARRAY(JSON('{"K2": 42}'))
+
+      -- [{"K2":{"K3":42}}]
+      JSON_ARRAY(JSON('{"K2":{"K3":42}}'))

Review Comment:
   nit: I think it would be good to give an example with more than one element 



-- 
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