Skip to content

[SPARK-55617][SQL][FOLLOWUP] Correct VariantGet @since to 4.3.0 and expand its class doc#56537

Closed
gengliangwang wants to merge 1 commit into
apache:masterfrom
gengliangwang:SPARK-55617-followup
Closed

[SPARK-55617][SQL][FOLLOWUP] Correct VariantGet @since to 4.3.0 and expand its class doc#56537
gengliangwang wants to merge 1 commit into
apache:masterfrom
gengliangwang:SPARK-55617-followup

Conversation

@gengliangwang

Copy link
Copy Markdown
Member

What changes were proposed in this pull request?

Follow-up to #54394 (SPARK-55617). Two documentation-only changes to the DSv2 connector expression VariantGet:

  • Correct the @since tag from 4.1.0 to 4.3.0.
  • Expand the class Javadoc (previously just "Variant get expression.") to describe what the expression represents.

Why are the changes needed?

This addresses a review comment on the original PR: VariantGet was marked @since 4.1.0, which does not match where the API actually ships. The change lands on master (5.0.0) and is backported to branch-4.x, so the API first appears in 4.3.0; the @since tag should reflect that. The original one-line class doc also did not explain what the expression is or how it maps to variant_get / try_variant_get.

Note: VariantExtraction and SupportsPushDownVariantExtractions (added under SPARK-54656) carry the same @since 4.1.0 and likely need an analogous follow-up under that ticket. They are intentionally left out of this PR to keep it scoped to SPARK-55617.

Does this PR introduce any user-facing change?

No behavior change. This only updates Javadoc and the @since tag so the published API documentation is accurate.

How was this patch tested?

Documentation-only change (Javadoc and @since); there is no code change, so no tests were added. Verified the new comment lines stay within the Java checkstyle line-length limit.

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

Yes, generated with the assistance of Claude Code (Anthropic).

This pull request and its description were written by Isaac.

…xpand its class doc

Addresses a review comment on apache#54394: VariantGet was marked `@since 4.1.0`, but the API ships in 4.3.0 (branch-4.x, and master 5.0.0). Update `@since` to 4.3.0 and expand the minimal class Javadoc to describe the expression (the connector-facing form of variant_get / try_variant_get, produced by V2ExpressionBuilder for DSv2 pushdown).

Co-authored-by: Isaac
@gengliangwang gengliangwang requested a review from pan3793 June 16, 2026 05:09
@gengliangwang

Copy link
Copy Markdown
Member Author

cc @qlong

@pan3793 pan3793 changed the title [SPARK-55617][SQL][FOLLOWUP] Correct VariantGet @since to 4.3.0 and expand its class doc [SPARK-55617][SQL][FOLLOWUP] Correct VariantGet @since to 4.3.0 and expand its class doc Jun 16, 2026

@qlong qlong left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@gengliangwang My mistake, thanks for fix it.

@dongjoon-hyun dongjoon-hyun left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

+1, LGTM.

@dongjoon-hyun

dongjoon-hyun commented Jun 16, 2026

Copy link
Copy Markdown
Member

BTW, please update JIRA information too. Fix Version is still 5.0.0, @gengliangwang .

Screenshot 2026-06-16 at 11 22 40

@qlong

qlong commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

@dongjoon-hyun @gengliangwang fixed the version in jira

image

@gengliangwang

Copy link
Copy Markdown
Member Author

Thanks all for the review. Merging to master/4.x

gengliangwang added a commit that referenced this pull request Jun 16, 2026
… expand its class doc

### What changes were proposed in this pull request?

Follow-up to #54394 (SPARK-55617). Two documentation-only changes to the DSv2 connector expression `VariantGet`:

- Correct the `since` tag from `4.1.0` to `4.3.0`.
- Expand the class Javadoc (previously just "Variant get expression.") to describe what the expression represents.

### Why are the changes needed?

This addresses a [review comment](#54394 (comment)) on the original PR: `VariantGet` was marked `since 4.1.0`, which does not match where the API actually ships. The change lands on master (5.0.0) and is backported to branch-4.x, so the API first appears in 4.3.0; the `since` tag should reflect that. The original one-line class doc also did not explain what the expression is or how it maps to `variant_get` / `try_variant_get`.

> Note: `VariantExtraction` and `SupportsPushDownVariantExtractions` (added under SPARK-54656) carry the same `since 4.1.0` and likely need an analogous follow-up under that ticket. They are intentionally left out of this PR to keep it scoped to SPARK-55617.

### Does this PR introduce _any_ user-facing change?

No behavior change. This only updates Javadoc and the `since` tag so the published API documentation is accurate.

### How was this patch tested?

Documentation-only change (Javadoc and `since`); there is no code change, so no tests were added. Verified the new comment lines stay within the Java checkstyle line-length limit.

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

Yes, generated with the assistance of Claude Code (Anthropic).

This pull request and its description were written by Isaac.

Closes #56537 from gengliangwang/SPARK-55617-followup.

Authored-by: Gengliang Wang <gengliang@apache.org>
Signed-off-by: Gengliang Wang <gengliang@apache.org>
(cherry picked from commit 8c6f26b)
Signed-off-by: Gengliang Wang <gengliang@apache.org>
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.

5 participants