[SPARK-29444][FOLLOWUP] add doc and python parameter for ignoreNullFields in json generating #26227
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
ok to test |
|
Test build #112543 has finished for PR 26227 at commit
|
jackylee-ch
changed the title
HyukjinKwon
reviewed
Oct 24, 2019
| .doc("If false, JacksonGenerator will generate null for null fields in Struct.") | ||
| .stringConf | ||
| .createWithDefault("true") | ||
| .doc("Whether to ignore null fields in column/struct during json generating. " + |
There was a problem hiding this comment.
I would just write like this:
Whether to ignore null fields when generating JSON objects in JSON data source and
JSON functions such as to_json.
If false, it generates null for null fields in JSON objects.
There was a problem hiding this comment.
Good, it's better.
HyukjinKwon
reviewed
Oct 24, 2019
| @@ -687,6 +687,8 @@ final class DataFrameWriter[T] private[sql](ds: Dataset[T]) { | |||
| * <li>`encoding` (by default it is not set): specifies encoding (charset) of saved json | |||
| * files. If it is not set, the UTF-8 charset will be used. </li> | |||
| * <li>`lineSep` (default `\n`): defines the line separator that should be used for writing.</li> | |||
| * <li>`ignoreNullFields` (default `true`): whether to ignore null fields in column/struct | |||
| * during json generating. </li> | |||
|
Test build #112600 has finished for PR 26227 at commit
|
dongjoon-hyun
approved these changes
Oct 24, 2019
Closed
47 tasks
agirish
pushed a commit
to HPEEzmeral/apache-spark
that referenced
this pull request
May 5, 2022
* [SPARK-29444] Add configuration to support JacksonGenrator to keep fields with null values
As mentioned in jira, sometimes we need to be able to support the retention of null columns when writing JSON.
For example, sparkmagic(used widely in jupyter with livy) will generate sql query results based on DataSet.toJSON and parse JSON to pandas DataFrame to display. If there is a null column, it is easy to have some column missing or even the query result is empty. The loss of the null column in the first row, may cause parsing exceptions or loss of entire column data.
Example in spark-shell.
scala> spark.sql("select null as a, 1 as b").toJSON.collect.foreach(println)
{"b":1}
scala> spark.sql("set spark.sql.jsonGenerator.struct.ignore.null=false")
res2: org.apache.spark.sql.DataFrame = [key: string, value: string]
scala> spark.sql("select null as a, 1 as b").toJSON.collect.foreach(println)
{"a":null,"b":1}
Add new test to JacksonGeneratorSuite
Lead-authored-by: stczwd <[email protected]>
Co-authored-by: Jackey Lee <[email protected]>
Signed-off-by: Wenchen Fan <[email protected]>
(cherry picked from commit with id 78b0cbe)
* [SPARK-29444][FOLLOWUP] add doc and python parameter for ignoreNullFields in json generating
# What changes were proposed in this pull request?
Add description for ignoreNullFields, which is commited in apache#26098 , in DataFrameWriter and readwriter.py.
Enable user to use ignoreNullFields in pyspark.
### Does this PR introduce any user-facing change?
No
### How was this patch tested?
run unit tests
Closes apache#26227 from stczwd/json-generator-doc.
Authored-by: stczwd <[email protected]>
Signed-off-by: Dongjoon Hyun <[email protected]>
Co-authored-by: stczwd <[email protected]>
udaynpusa
pushed a commit
to mapr/spark
that referenced
this pull request
Jan 30, 2024
* [SPARK-29444] Add configuration to support JacksonGenrator to keep fields with null values
As mentioned in jira, sometimes we need to be able to support the retention of null columns when writing JSON.
For example, sparkmagic(used widely in jupyter with livy) will generate sql query results based on DataSet.toJSON and parse JSON to pandas DataFrame to display. If there is a null column, it is easy to have some column missing or even the query result is empty. The loss of the null column in the first row, may cause parsing exceptions or loss of entire column data.
Example in spark-shell.
scala> spark.sql("select null as a, 1 as b").toJSON.collect.foreach(println)
{"b":1}
scala> spark.sql("set spark.sql.jsonGenerator.struct.ignore.null=false")
res2: org.apache.spark.sql.DataFrame = [key: string, value: string]
scala> spark.sql("select null as a, 1 as b").toJSON.collect.foreach(println)
{"a":null,"b":1}
Add new test to JacksonGeneratorSuite
Lead-authored-by: stczwd <[email protected]>
Co-authored-by: Jackey Lee <[email protected]>
Signed-off-by: Wenchen Fan <[email protected]>
(cherry picked from commit with id 78b0cbe)
* [SPARK-29444][FOLLOWUP] add doc and python parameter for ignoreNullFields in json generating
# What changes were proposed in this pull request?
Add description for ignoreNullFields, which is commited in apache#26098 , in DataFrameWriter and readwriter.py.
Enable user to use ignoreNullFields in pyspark.
### Does this PR introduce any user-facing change?
No
### How was this patch tested?
run unit tests
Closes apache#26227 from stczwd/json-generator-doc.
Authored-by: stczwd <[email protected]>
Signed-off-by: Dongjoon Hyun <[email protected]>
Co-authored-by: stczwd <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
Add description for ignoreNullFields, which is commited in #26098 , in DataFrameWriter and readwriter.py.
Enable user to use ignoreNullFields in pyspark.
Does this PR introduce any user-facing change?
No
How was this patch tested?
run unit tests