Skip to content

Hibernate: recommend MySQLDialect over TiDBDialect (#22193)#22231

Merged
ti-chi-bot[bot] merged 8 commits intopingcap:release-8.5from
ti-chi-bot:cherry-pick-22193-to-release-8.5
Dec 24, 2025
Merged

Hibernate: recommend MySQLDialect over TiDBDialect (#22193)#22231
ti-chi-bot[bot] merged 8 commits intopingcap:release-8.5from
ti-chi-bot:cherry-pick-22193-to-release-8.5

Conversation

@ti-chi-bot
Copy link
Copy Markdown
Member

This is an automated cherry-pick of #22193

What is changed, added or deleted? (Required)

Closes #21618

This PR updates the Hibernate documentation to recommend MySQLDialect over TiDBDialect.

Background: Starting with Hibernate 7.x, TiDBDialect was moved from hibernate-core to hibernate-community-dialects (HHH-19361). Since PingCAP has no current maintenance plan for the community dialect, and TiDB is highly MySQL-compatible, using MySQLDialect is the recommended approach for long-term compatibility.

Changes:

  • Update dialect recommendation from org.hibernate.dialect.TiDBDialect to org.hibernate.dialect.MySQLDialect
  • Add reference to org.hibernate.community.dialect.TiDBDialect in Hibernate community dialects for users who need it
  • Add guidance for reporting compatibility issues if users encounter any

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

alastori and others added 7 commits December 24, 2025 08:31
- Update dialect recommendation from TiDBDialect to MySQLDialect
- Add link to TiDBDialect in Hibernate community dialects for users who need it
- Add guidance for reporting compatibility issues

Closes pingcap#21618
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Add an extensible "Compatibility notes for MySQLDialect" section to
document behavioral differences when using MySQLDialect with TiDB.

Initial content covers SERIALIZABLE isolation level handling and
the tidb_skip_isolation_level_check workaround.
Co-authored-by: Grace Cai <qqzczy@126.com>
@ti-chi-bot ti-chi-bot added area/develop This PR relates to the area of TiDB App development. lgtm size/M Denotes a PR that changes 30-99 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. labels Dec 24, 2025
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @ti-chi-bot, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the Hibernate documentation to guide users towards using MySQLDialect when connecting to TiDB, citing the lack of maintenance for the TiDBDialect and TiDB's strong MySQL compatibility. It also provides crucial information on potential compatibility behaviors related to transaction isolation levels and CHECK constraints, ensuring users have the necessary context for a smooth integration.

Highlights

  • Dialect Recommendation Change: The documentation now recommends org.hibernate.dialect.MySQLDialect instead of org.hibernate.dialect.TiDBDialect for connecting Hibernate to TiDB.
  • Reasoning for Change: This shift is due to TiDBDialect being moved to Hibernate community dialects and not being maintained by PingCAP, while TiDB maintains high MySQL compatibility.
  • Compatibility Guidance: New sections have been added to explain specific compatibility considerations when using MySQLDialect with TiDB, covering SERIALIZABLE isolation level and CHECK constraints, along with recommended workarounds.
  • Issue Reporting: Users are now guided on how to report compatibility issues if they arise when using MySQLDialect.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the Hibernate documentation to recommend MySQLDialect over TiDBDialect, which is a sensible change given the maintenance status of TiDBDialect. The changes are clear and provide good context for users, including a new section on compatibility with MySQLDialect. I've provided a few suggestions to improve wording and fix a minor typo, aligning the text more closely with the repository's style guide by using a more direct tone and active voice.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@hfxsd
Copy link
Copy Markdown
Collaborator

hfxsd commented Dec 24, 2025

/approve

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot bot commented Dec 24, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hfxsd

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot bot added the approved label Dec 24, 2025
@ti-chi-bot ti-chi-bot bot merged commit 58f3928 into pingcap:release-8.5 Dec 24, 2025
9 checks passed
@ti-chi-bot ti-chi-bot bot deleted the cherry-pick-22193-to-release-8.5 branch December 24, 2025 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/develop This PR relates to the area of TiDB App development. lgtm size/M Denotes a PR that changes 30-99 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants