Skip to content

Conversation

@jaogoy
Copy link
Contributor

@jaogoy jaogoy commented Dec 25, 2025

Why I'm doing:

It needs an overall doc to describe starrocks-sqlalchemy for schema management and migration.

What I'm doing:

Add this doc under integrations section.

Fixes #issue

What type of PR is this:

  • BugFix
  • Feature
  • Enhancement
  • Refactor
  • UT
  • Doc
  • Tool

Does this PR entail a change in behavior?

  • Yes, this PR will result in a change in behavior.
  • No, this PR will not result in a change in behavior.

If yes, please specify the type of change:

  • Interface/UI changes: syntax, type conversion, expression evaluation, display information
  • Parameter changes: default values, similar parameters but with different default values
  • Policy changes: use new policy to replace old one, functionality automatically enabled
  • Feature removed
  • Miscellaneous: upgrade & downgrade compatibility, etc.

Checklist:

  • I have added test cases for my bug fix or my new feature
  • This pr needs user documentation (for new or modified features or behaviors)
    • I have added documentation for my new feature or new function
  • This is a backport pr

Bugfix cherry-pick branch check:

  • I have checked the version labels which the pr will be auto-backported to the target branch
    • 4.0
    • 3.5
    • 3.4
    • 3.3

Note

Introduces comprehensive documentation for managing StarRocks schemas with SQLAlchemy and Alembic, and standardizes example option names.

  • Adds docs/en/integrations/smt/starrocks_sqlalchemy.md: end-to-end guide covering tables, views/MVs, autogenerate, sqlacodegen, and best practices
  • Registers the new page in docs/docusaurus/sidebars.json
  • Standardizes examples to lowercase starrocks_* option names in README, Alembic, and Tables guides; clarifies casing guidance
  • Updates Alembic docs to validate and expand View/MV autogenerate support

Written by Cursor Bugbot for commit 5c8ca84. This will update automatically on new commits. Configure here.

Unified starrocks property names to be lowercase.

Signed-off-by: jaogoy <[email protected]>
@jaogoy jaogoy requested a review from DanRoscigno December 25, 2025 02:46
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 25, 2025
@mergify mergify bot assigned jaogoy Dec 25, 2025
@github-actions
Copy link

[Java-Extensions Incremental Coverage Report]

pass : 0 / 0 (0%)

@github-actions
Copy link

[FE Incremental Coverage Report]

pass : 0 / 0 (0%)

@github-actions
Copy link

[BE Incremental Coverage Report]

pass : 0 / 0 (0%)

@alvin-celerdata
Copy link
Contributor

@cursor review

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

✅ Bugbot reviewed your changes and found no bugs!

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants