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: add respective json_is UDFs for JSON type #4726

Merged
merged 5 commits into from
Sep 18, 2024

Conversation

CookiePieWw
Copy link
Collaborator

@CookiePieWw CookiePieWw commented Sep 11, 2024

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

#3686 #4515 #4230

What's changed and what's your intention?

As title. Add following json_is UDFs: json_is_null, json_is_array, json_is_object, json_is_int, json_is_float, json_is_string, json_is_bool. Also rename to_json to parse_json and add some sqlness tests.

Checklist

  • I have written the necessary rustdoc comments.
  • I have added the necessary unit tests and integration tests.
  • This PR requires documentation updates.

@CookiePieWw CookiePieWw requested a review from a team as a code owner September 11, 2024 15:03
Copy link
Contributor

coderabbitai bot commented Sep 11, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the docs-not-required This change does not impact docs. label Sep 11, 2024
Copy link
Member

@WenyXu WenyXu left a comment

Choose a reason for hiding this comment

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

Great! 🚀 LGTM

@CookiePieWw CookiePieWw changed the title feat: add respective json_is UDFs feat: add respective json_is UDFs for JSON type Sep 11, 2024
Copy link

codecov bot commented Sep 11, 2024

Codecov Report

Attention: Patch coverage is 87.09677% with 16 lines in your changes missing coverage. Please review.

Project coverage is 84.51%. Comparing base (67fb3d0) to head (3e6fd12).
Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4726      +/-   ##
==========================================
- Coverage   84.79%   84.51%   -0.28%     
==========================================
  Files        1115     1116       +1     
  Lines      201197   201312     +115     
==========================================
- Hits       170612   170146     -466     
- Misses      30585    31166     +581     

@sunng87
Copy link
Member

sunng87 commented Sep 11, 2024

Do you think it will be a good idea to have jq as a built-in function? I think it can cover most JSON operations so we don't have to implement and document them one-by-one

@CookiePieWw
Copy link
Collaborator Author

CookiePieWw commented Sep 12, 2024

Do you think it will be a good idea to have jq as a built-in function? I think it can cover most JSON operations so we don't have to implement and document them one-by-one

Yes, jq is quite powerful, but it returns a json type. The problem is that when we use UDFs, the binary data of json type are processed through datafusion and then the type info are erased since datafusion has no json type, then the servers would return plain binary data to clients.

We may have 2 choice here:

  • let users use json_to_string function whenever using json type.
  • or let users specify the type they want here.

BTW, databend provide jq function as well as is_<type> function and many other functions. Maybe it's for flexibility?

@paomian
Copy link
Contributor

paomian commented Sep 18, 2024

In my opinion, parse_json should be called by default when not performing any get path operation on a json column, rather than having to call this function manually for every query. Refer to https://www.postgresql.org/docs/current/datatype-json.html

But I think this can be optimized later without blocking this pr merge.

rest LGTM

@WenyXu
Copy link
Member

WenyXu commented Sep 18, 2024

In my opinion, parse_json should be called by default when not performing any get path operation on a json column, rather than having to call this function manually for every query. Refer to https://www.postgresql.org/docs/current/datatype-json.html

But I think this can be optimized later without blocking this pr merge.

rest LGTM

Both ways work(i.e., INSERT INTO table VALUES (parse_json('{ "a": 1}'));, INSERT INTO table VALUES ('{ "a": 1}');)

@WenyXu WenyXu added this pull request to the merge queue Sep 18, 2024
Merged via the queue into GreptimeTeam:main with commit f73fb82 Sep 18, 2024
32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-not-required This change does not impact docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants