Skip to content

[SPARK-58745][DOCS] Document missing JSON and XML data source options - #57971

Open
uros-b wants to merge 1 commit into
apache:masterfrom
uros-b:doc-datasource-missing-options
Open

[SPARK-58745][DOCS] Document missing JSON and XML data source options#57971
uros-b wants to merge 1 commit into
apache:masterfrom
uros-b:doc-datasource-missing-options

Conversation

@uros-b

@uros-b uros-b commented Aug 12, 2026

Copy link
Copy Markdown
Member

What changes were proposed in this pull request?

Adds table rows for options that are registered in the JSON and XML data sources but were missing from the option tables:

  • JSON: pretty, writeNonAsciiCharacterAsCodePoint
  • XML: indent, multiLine, prefersDecimal, preferDate

Why are the changes needed?

Each is a real user-facing option registered via newOption, so it passes option validation and can be set by any user, yet none appeared in the documented tables. The gap was found by diffing the newOption registrations in JSONOptions/XmlOptions against the <code> entries in each doc.

Does this PR introduce any user-facing change?

No, other than newly documenting existing options.

How was this patch tested?

Documentation only. Every default and description is taken from source: indent defaults to XmlOptions.DEFAULT_INDENT (four spaces); multiLine defaults to true for XML; prefersDecimal/preferDate affect schema inference and preferDate is disabled when spark.sql.legacy.timeParserPolicy is LEGACY; pretty and writeNonAsciiCharacterAsCodePoint are write-side and default to false.

After this change the JSON table is complete. The XML table still omits useLegacyXMLParser, a legacy parser-implementation switch, which is intentionally left undocumented.

Was this patch authored or co-authored using generative AI tooling?

Generated-by: Claude Code (Opus 4.8)

@uros-b uros-b left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Waiting for CI

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants