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

fix: clickhouse-connect engine SSH parameter #32348

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

maybedino
Copy link

SUMMARY

This adds the missing SSH parameter to the clickhouse-connect engine.

Clickhouse engine makes copy of BasicParametersSchema instead of just inheriting from it. Maybe that's not ideal, but I decided to keep it like this and add the SSH parameter as well.

TESTING INSTRUCTIONS

Add a new clickhouse database (with clickhouse-connect), the SSH option should show up and work.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags: Change SSH_TUNNELING to True
  • Changes UI - (not really but the SSH toggle will show up now)
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@dosubot dosubot bot added the data:connect:clickhouse Related to Clickhouse label Feb 21, 2025
Copy link

@korbit-ai korbit-ai bot left a comment

Choose a reason for hiding this comment

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

I've completed my review and didn't find any issues.

Files scanned
File Path Reviewed
superset/db_engine_specs/clickhouse.py

Explore our documentation to understand the languages and file types we support and the files we ignore.

Need a new review? Comment /korbit-review on this PR and I'll review your latest changes.

Korbit Guide: Usage and Customization

Interacting with Korbit

  • You can manually ask Korbit to review your PR using the /korbit-review command in a comment at the root of your PR.
  • You can ask Korbit to generate a new PR description using the /korbit-generate-pr-description command in any comment on your PR.
  • Too many Korbit comments? I can resolve all my comment threads if you use the /korbit-resolve command in any comment on your PR.
  • Chat with Korbit on issues we post by tagging @korbit-ai in your reply.
  • Help train Korbit to improve your reviews by giving a 👍 or 👎 on the comments Korbit posts.

Customizing Korbit

  • Check out our docs on how you can make Korbit work best for you and your team.
  • Customize Korbit for your organization through the Korbit Console.

Current Korbit Configuration

General Settings
Setting Value
Review Schedule Automatic excluding drafts
Max Issue Count 10
Automatic PR Descriptions
Issue Categories
Category Enabled
Documentation
Logging
Error Handling
Readability
Design
Performance
Security
Functionality

Feedback and Support

Note

Korbit Pro is free for open source projects 🎉

Looking to add Korbit to your team? Get started with a free 2 week trial here

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Congrats on making your first PR and thank you for contributing to Superset! 🎉 ❤️

We hope to see you in our Slack community too! Not signed up? Use our Slack App to self-register.

Copy link

codecov bot commented Feb 21, 2025

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 83.45%. Comparing base (76d897e) to head (df77034).
Report is 1479 commits behind head on master.

Files with missing lines Patch % Lines
superset/db_engine_specs/clickhouse.py 50.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           master   #32348       +/-   ##
===========================================
+ Coverage   60.48%   83.45%   +22.96%     
===========================================
  Files        1931      546     -1385     
  Lines       76236    39100    -37136     
  Branches     8568        0     -8568     
===========================================
- Hits        46114    32631    -13483     
+ Misses      28017     6469    -21548     
+ Partials     2105        0     -2105     
Flag Coverage Δ
hive 48.50% <50.00%> (-0.67%) ⬇️
javascript ?
mysql 75.85% <50.00%> (?)
postgres 75.92% <50.00%> (?)
presto 53.03% <50.00%> (-0.78%) ⬇️
python 83.45% <50.00%> (+19.96%) ⬆️
sqlite 75.43% <50.00%> (?)
unit 61.06% <50.00%> (+3.44%) ⬆️

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

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

@mistercrunch
Copy link
Member

Looks like mypy is complaining, otherwise LGTM

@rusackas
Copy link
Member

Superset uses Git pre-commit hooks courtesy of pre-commit. To install run the following:

pip3 install -r requirements/development.txt
pre-commit install
A series of checks will now run when you make a git commit.

Alternatively it is possible to run pre-commit by running pre-commit manually:

pre-commit run --all-files

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

SSH_TUNNELING is not shown in UI for clickhouse-connect
4 participants