dongjoon-hyun commented on a change in pull request #27836: [SPARK-31009][SQL] Support json_object_keys function URL: https://github.com/apache/spark/pull/27836#discussion_r403507606
########## File path: sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/jsonExpressions.scala ########## @@ -796,3 +797,71 @@ case class SchemaOfJson( override def prettyName: String = "schema_of_json" } + +/** + * A function which returns all the keys of outer JSON object. + */ +@ExpressionDescription( + usage = "_FUNC_(json_object) - returns all the keys of outer JSON object.", + arguments = """ + Arguments: + * json_object - A JSON object. If it is an invalid string, the function returns null. + If it is a JSON array, an illegal argument exception will be thrown. Review comment: Could you sync the PR description and this function description consistently? This function description looks too simple and the PR description seems wrong in the part `Analysis Exception`. For end users, this function description is the only visible one. ``` If invalid json expression is given, NULL will be returned. If a null string or json array is given, an Analysis Exception is thrown. If valid json object is given, all the keys of outer object will be returned as array. For empty json object, empty array is returned. ``` ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
