Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(sql-udf): better hint display for invalid sql udf definition #15091

Merged
merged 18 commits into from
Feb 26, 2024

Conversation

xzhseh
Copy link
Contributor

@xzhseh xzhseh commented Feb 13, 2024

I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.

What's changed and what's your intention?

resolve #14853.

BEFORE

As shown in the above issue.

AFTER

screenshot.png

P.S. IMO the cost of constructing Regex when error definition is found is acceptable to display a better hint for user.

Note that the current hint works for invalid column / parameter, function hint will be supported in subsequent PR.

Checklist

  • I have written necessary rustdoc comments
  • I have added necessary unit tests and integration tests
  • I have added test labels as necessary. See details.
  • I have added fuzzing tests or opened an issue to track them. (Optional, recommended for new SQL features Sqlsmith: Sql feature generation #7934).
  • My PR contains breaking changes. (If it deprecates some features, please create a tracking issue to remove them in the future).
  • All checks passed in ./risedev check (or alias, ./risedev c)
  • My PR changes performance-critical code. (Please run macro/micro-benchmarks and show the results.)
  • My PR contains critical fixes that are necessary to be merged into the latest release. (Please check out the details)

Documentation

  • My PR needs documentation updates. (Please use the Release note section below to summarize the impact on users)

Release note

If this PR includes changes that directly affect users or other significant modifications relevant to the community, kindly draft a release note to provide a concise summary of these changes. Please prioritize highlighting the impact these changes will have on users.

@xzhseh xzhseh self-assigned this Feb 13, 2024
@xzhseh xzhseh requested a review from a team as a code owner February 13, 2024 20:02
@xzhseh xzhseh requested a review from xxchan February 14, 2024 03:22
@BugenZhao
Copy link
Member

BugenZhao commented Feb 14, 2024

The idea is great and it's definitely an improvement to the user experience.

Actually I'm wondering if this could be applied to other statements as well. I believe the ultimate solution could be attaching a span to each AST item during parsing. Databend had a good practice on this (but it could require a quite large amount of work to refactor):

https://medium.com/@databend/the-new-databend-sql-planner-e1b1f028a594

@xzhseh
Copy link
Contributor Author

xzhseh commented Feb 14, 2024

The idea is great and it's definitely an improvement to the user experience.

Actually I'm wondering if this could be applied to other statements as well. I believe the ultimate solution could be attaching a span to each AST item during parsing. Databend had a good practice on this:

https://medium.com/@databend/the-new-databend-sql-planner-e1b1f028a594

Indeed, let me do some further investigations on this and see if we can come up with an ultimate solution. (And I can work on this constantly 😄)

src/frontend/src/binder/expr/column.rs Outdated Show resolved Hide resolved
src/frontend/src/binder/expr/mod.rs Outdated Show resolved Hide resolved
@wangrunji0408
Copy link
Contributor

The idea is great and it's definitely an improvement to the user experience.
Actually I'm wondering if this could be applied to other statements as well. I believe the ultimate solution could be attaching a span to each AST item during parsing. Databend had a good practice on this:
https://medium.com/@databend/the-new-databend-sql-planner-e1b1f028a594

Indeed, let me do some further investigations on this and see if we can come up with an ultimate solution. (And I can work on this constantly 😄)

We can learn from syn on how to gracefully attach span to each AST node.

@BugenZhao
Copy link
Member

We can learn from syn on how to gracefully attach span to each AST node.

Could you elaborate more? Do you mean the span in the proc_macro crate?

Copy link
Contributor

@wangrunji0408 wangrunji0408 left a comment

Choose a reason for hiding this comment

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

Generally LGTM!

@wangrunji0408
Copy link
Contributor

wangrunji0408 commented Feb 26, 2024

We can learn from syn on how to gracefully attach span to each AST node.

Could you elaborate more? Do you mean the span in the proc_macro crate?

IIUC, in syn, each AST node is recursively composed by a series of tokens (as leaf nodes of the AST). Each token provides its own span. And the span of each AST node can be computed as the join of all children's by derive macro.

However, adding span to sqlparser is still a big project. Someone has proposed it several years ago but it has not been landed until now.

@xzhseh xzhseh added this pull request to the merge queue Feb 26, 2024
Merged via the queue into main with commit aedfd66 Feb 26, 2024
27 of 28 checks passed
@xzhseh xzhseh deleted the xzhseh/sql-udf-creation-better-hint-display branch February 26, 2024 22:08
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.

Better hint display for sql udf creation
5 participants