Skip to content

fix(docs): Use modern driver package for CrateDB - #38358

Closed
amotl wants to merge 2 commits into
apache:masterfrom
crate-workbench:cratedb-docs
Closed

fix(docs): Use modern driver package for CrateDB#38358
amotl wants to merge 2 commits into
apache:masterfrom
crate-workbench:cratedb-docs

Conversation

@amotl

@amotl amotl commented Mar 3, 2026

Copy link
Copy Markdown
Contributor

User description

Dear Superset maintainers,

on the documentation page about CrateDB, we discovered a possible leftover from the migration from crate[sqlalchemy] to sqlalchemy-cratedb the other day.

Other than merging to master, can you possibly commandeer this patch to be backported to earlier releases of Superset? Thank you in advance!

With kind regards,
Andreas.


CodeAnt-AI Description

Use sqlalchemy-cratedb as the recommended CrateDB driver and update CrateDB homepage link

What Changed

  • Recommended CrateDB driver package changed from crate[sqlalchemy] to sqlalchemy-cratedb in engine specs and documentation entries
  • CrateDB homepage URL updated from https://crate.io/ to https://cratedb.com/
  • Release notes (UPDATING) now mention the PyPI package switch for CrateDB

Impact

✅ Clearer CrateDB install instructions
✅ Fewer driver installation mismatches
✅ Accurate CrateDB homepage link

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

@bito-code-review

bito-code-review Bot commented Mar 3, 2026

Copy link
Copy Markdown
Contributor

Code Review Agent Run #e4987e

Actionable Suggestions - 0
Review Details
  • Files reviewed - 1 · Commit Range: e4dd969..5d7abd0
    • superset/db_engine_specs/crate.py
  • Files skipped - 1
    • docs/src/data/databases.json - Reason: Filter setting
  • Tools
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful
    • MyPy (Static Code Analysis) - ✔︎ Successful
    • Astral Ruff (Static Code Analysis) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

  • /review - Manually triggers a full AI review.

  • /pause - Pauses automatic reviews on this pull request.

  • /resume - Resumes automatic reviews.

  • /resolve - Marks all Bito-posted review comments as resolved.

  • /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by Bito Logo

@github-actions github-actions Bot added the doc Namespace | Anything related to documentation label Mar 3, 2026
@dosubot dosubot Bot added the data:connect Namespace | Anything related to db connections / integrations label Mar 3, 2026
@netlify

netlify Bot commented Mar 3, 2026

Copy link
Copy Markdown

Deploy Preview for superset-docs-preview ready!

Name Link
🔨 Latest commit f0cbdd8
🔍 Latest deploy log https://app.netlify.com/projects/superset-docs-preview/deploys/69bd69cad5812200085087d8
😎 Deploy Preview https://deploy-preview-38358--superset-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@codecov

codecov Bot commented Mar 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.39%. Comparing base (c2a2191) to head (afa6b53).
⚠️ Report is 2 commits behind head on master.

❌ Your project check has failed because the head coverage (99.92%) is below the target coverage (100.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #38358      +/-   ##
==========================================
- Coverage   65.30%   64.39%   -0.91%     
==========================================
  Files        1819     2532     +713     
  Lines       72745   129896   +57151     
  Branches    23266    30048    +6782     
==========================================
+ Hits        47505    83651   +36146     
- Misses      25240    44789   +19549     
- Partials        0     1456    +1456     
Flag Coverage Δ
hive 40.56% <ø> (?)
mysql 61.54% <ø> (?)
postgres 61.61% <ø> (?)
presto 40.58% <ø> (?)
python 63.22% <ø> (?)
sqlite 61.24% <ø> (?)
unit 100.00% <ø> (?)

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.

🚀 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.

{
"name": "crate",
"pypi_package": "crate[sqlalchemy]",
"pypi_package": "sqlalchemy-cratedb",

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.

Can you add a line item in UPDATING.md about switching the pypi package?

@amotl amotl Mar 4, 2026

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.

Sure, thank you. I've just updated the patch as you suggested, cherry-picking the proposal by the code review bot.

@amotl amotl Mar 6, 2026

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.

Hi @sadpandajoe. Do you think the patch is eligible for merging now? Will you take care about backporting it to earlier active maintenance branches of Apache Superset, for example by using Mergify, or shall we do it manually after this patch got merged?

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.

Hi again. Please let us know if this patch needs any further love. Thank you!

@bito-code-review

Copy link
Copy Markdown
Contributor

The PR switches the CrateDB PyPI package from 'crate[sqlalchemy]' to 'sqlalchemy-cratedb'. Here's a suggested line item for UPDATING.md to document this change.

UPDATING.md

- Switched CrateDB PyPI package from `crate[sqlalchemy]` to `sqlalchemy-cratedb`.

@amotl
amotl requested a review from sadpandajoe March 4, 2026 21:37
@bito-code-review

bito-code-review Bot commented Mar 4, 2026

Copy link
Copy Markdown
Contributor

Code Review Agent Run #7a9076

Actionable Suggestions - 0
Review Details
  • Files reviewed - 1 · Commit Range: 9ae5fd7..f09a848
    • superset/db_engine_specs/crate.py
  • Files skipped - 2
    • UPDATING.md - Reason: Filter setting
    • docs/src/data/databases.json - Reason: Filter setting
  • Tools
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful
    • MyPy (Static Code Analysis) - ✔︎ Successful
    • Astral Ruff (Static Code Analysis) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

  • /review - Manually triggers a full AI review.

  • /pause - Pauses automatic reviews on this pull request.

  • /resume - Resumes automatic reviews.

  • /resolve - Marks all Bito-posted review comments as resolved.

  • /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by Bito Logo

@codeant-ai-for-open-source codeant-ai-for-open-source Bot added the size:XS This PR changes 0-9 lines, ignoring generated files label Mar 20, 2026
@bito-code-review

bito-code-review Bot commented Mar 20, 2026

Copy link
Copy Markdown
Contributor

Code Review Agent Run #7e3602

Actionable Suggestions - 0
Review Details
  • Files reviewed - 1 · Commit Range: 3182c71..afa6b53
    • superset/db_engine_specs/crate.py
  • Files skipped - 2
    • UPDATING.md - Reason: Filter setting
    • docs/src/data/databases.json - Reason: Filter setting
  • Tools
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful
    • MyPy (Static Code Analysis) - ✔︎ Successful
    • Astral Ruff (Static Code Analysis) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

  • /review - Manually triggers a full AI review.

  • /pause - Pauses automatic reviews on this pull request.

  • /resume - Resumes automatic reviews.

  • /resolve - Marks all Bito-posted review comments as resolved.

  • /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by Bito Logo

@rusackas rusackas 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.

I'll see if I an get this to pass CI, so we can merge it. LGTM

@rusackas

Copy link
Copy Markdown
Member

@amotl I had a go at rebasing this to clear the conflicts so it could land, but I can't push, looks like "Allow edits by maintainers" isn't enabled on this one. Could you rebase on current master?

While I was in there I noticed most of this seems to have landed already (homepage is cratedb.com, and sqlalchemy-cratedb is in pypi_packages), so it might come down to just the driver block's pypi_package still being crate[sqlalchemy]. Worth a look at whether it's still needed. Just ping me :)

@amotl

amotl commented Jun 19, 2026

Copy link
Copy Markdown
Contributor Author

Hi @rusackas. Thank you for pinging me. @florinutz: Could you take over my branch and bring it to completion according to the suggestions by Evan? 🙏

@rusackas

Copy link
Copy Markdown
Member

Heya... just checking in. Happy to "adopt" the work here on a new PR if time isn't available or flipping on maintainer commits can't be enabled.

@amotl

amotl commented Jul 15, 2026

Copy link
Copy Markdown
Contributor Author

Hi Evan. Thanks for your swift reply. I can't turn on maintainer commits, and lost access to crate-workbench. Yes, please recycle my changes into a different PR. 🙏

@rusackas

Copy link
Copy Markdown
Member

Will do! Thanks for lining up the shot :D

@rusackas

Copy link
Copy Markdown
Member

Brought this forward as #42125, closing this one out. Thanks again for flagging it!

@rusackas rusackas closed this Jul 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

data:connect Namespace | Anything related to db connections / integrations doc Namespace | Anything related to documentation size/XS size:XS This PR changes 0-9 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants