Skip to content

[SQL] Support positional parameters#38880

Open
Abacn wants to merge 1 commit into
apache:masterfrom
Abacn:sql-support-parameters
Open

[SQL] Support positional parameters#38880
Abacn wants to merge 1 commit into
apache:masterfrom
Abacn:sql-support-parameters

Conversation

@Abacn

@Abacn Abacn commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Fix #18563

Please add a meaningful description for your change here


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enables support for positional parameters in Apache Beam SQL, addressing a long-standing limitation. By implementing a parameter binding mechanism during the logical plan conversion phase, the changes allow users to safely execute parameterized queries. The update includes robust handling for various temporal data types to ensure consistent behavior across different input formats.

Highlights

  • Positional Parameter Support: Added support for positional parameters in Beam SQL queries, allowing users to pass dynamic values using the '?' placeholder.
  • Parameter Binding Implementation: Introduced a 'ParameterBinder' class that extends 'RexShuttle' to safely inject positional parameters into the logical plan.
  • Data Type Handling: Implemented comprehensive cleaning and conversion logic for various date and time types (Joda Time, Java Time, SQL Timestamp) to ensure compatibility with SQL parameter binding.
New Features

🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request introduces support for positional query parameters in Beam SQL by implementing a ParameterBinder (which extends RexShuttle) to replace dynamic parameters with their literal values. It also adds corresponding unit tests in BeamSqlDslParametersTest. Feedback on these changes highlights a compilation error in bindParameters where a RexShuttle is incorrectly passed to RelNode.accept, which expects a RelShuttle. Additionally, it is suggested to update the logging statement to output the resolved plan (relNode) rather than the original plan with unbound parameters.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment on lines +240 to +247
private static RelNode bindParameters(RelNode rel, RexShuttle binder) {
RelNode newRel = rel.accept(binder);
java.util.List<RelNode> newInputs = new java.util.ArrayList<>();
for (RelNode input : newRel.getInputs()) {
newInputs.add(bindParameters(input, binder));
}
return newRel.copy(newRel.getTraitSet(), newInputs);
}

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.

critical

The bindParameters method attempts to call rel.accept(binder) where binder is a RexShuttle. However, in Apache Calcite, RelNode only has an accept(RelShuttle) method, and RexShuttle does not implement RelShuttle. This will cause a compilation error.

To apply a RexShuttle to a RelNode's expressions, you should use a RelShuttle that visits the RelNode and applies the RexShuttle to its expressions (for example, by overriding visit methods or using rel.accept(new RelShuttleImpl() { ... })). Since doing this manually for all relational operators is verbose, you can use rel.accept(new RelShuttleImpl() { ... }) and override the visit methods, or use a custom RelShuttle implementation that handles expression transformation.

relNode,
new ParameterBinder(root.rel.getCluster().getRexBuilder(), queryParameters));
}
LOG.info("SQLPlan>\n{}", BeamSqlRelUtils.explainLazily(root.rel));

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.

medium

The logging statement still prints the original plan root.rel which contains unbound dynamic parameters (?). It would be more helpful to log the plan after parameter binding (relNode) so that the fully resolved query plan is visible in the logs.

Suggested change
LOG.info("SQLPlan>\n{}", BeamSqlRelUtils.explainLazily(root.rel));
LOG.info("SQLPlan>\n{}", BeamSqlRelUtils.explainLazily(relNode));

@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

@Abacn Abacn force-pushed the sql-support-parameters branch from 34e213b to 4f96a27 Compare June 10, 2026 01:16
@@ -33,19 +35,17 @@
import org.apache.beam.sdk.values.Row;
import org.junit.Rule;
import org.junit.Test;
import org.testcontainers.shaded.com.fasterxml.jackson.databind.MapperFeature;

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Introduced in #30902, this test never get exercised

@codecov

codecov Bot commented Jun 10, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 73.33333% with 12 lines in your changes missing coverage. Please review.
✅ Project coverage is 54.34%. Comparing base (d9117f4) to head (4f96a27).
⚠️ Report is 27 commits behind head on master.

Files with missing lines Patch % Lines
...m/sdk/extensions/sql/impl/CalciteQueryPlanner.java 73.33% 5 Missing and 7 partials ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##             master   #38880      +/-   ##
============================================
- Coverage     57.77%   54.34%   -3.44%     
+ Complexity    12969     1704   -11265     
============================================
  Files          2509     1062    -1447     
  Lines        260525   166465   -94060     
  Branches      10658     1250    -9408     
============================================
- Hits         150516    90461   -60055     
+ Misses       104318    73789   -30529     
+ Partials       5691     2215    -3476     
Flag Coverage Δ
java 67.55% <73.33%> (+3.37%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Calcite SQL] Query Parametrization

1 participant