add TiDB support in README.md

[crazycs520]

Signed-off-by: crazycs520 [email protected]

Description

Please explain the changes you made here.

add TiDB support in README.md

Checklist

• Code compiles correctly
• Created tests which fail without the change (if possible)
• All tests passing
• Extended the README / documentation, if necessary
• Added myself / the copyright holder to the AUTHORS file

Summary by CodeRabbit

• Documentation
  • Updated the system requirements to include Go version 1.19.
  • Specified support for MySQL (5.7+), MariaDB (10.3+), and TiDB by PingCAP.
  • Added guidelines for TiDB support and maintenance expectations.

[crazycs520]

@methane PTAL

[methane]

We won't officially support TiDB.
I don't want to maintain a list of products that have MySQL compatible protocols.

[crazycs520]

We won't officially support TiDB. I don't want to maintain a list of products that have MySQL compatible protocols.

Why Google CloudSQL and Sphinx can be in the list？TiDB is similar to them, TiDB is a NewSQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL compatible.

[methane]

I am saying that I want to remove them too.
But CloudSQL is more similar to MySQL than NoSQL that just using MySQL protocol.

[ghimsim]

Hi methane, I can understand your position. However, TiDB is an open source project too, just like your Go SQL driver and MySQL. If you can help us out just a little bit by putting our name on this list, it would really mean a lot to us. =)

You probably don't need more popularity for your driver, but we do intend to highlight your Go SQL driver on our developer portal as the Go driver to use for our product.

Thank you for what you do!

[methane]

If you can help us out just a little bit by putting our name on this list, it would really mean a lot to us. =)

You are underestimating our efforts. Putting the name is not just putting the name.
It will make TiDB users ask help on our issue tracker although I never used TiDB.

[ghimsim]

Hi methane, thank you for helping us understand your concerns! To give you a peace of mind, we are willing to help out in any way to maintain the driver's compatibility with TiDB. For instance, we can designate a few TiDB engineers to review any PRs you wish for us to review, and we can provide resources to maintain a better CI env for your repo. And if there are any questions about TiDB, we are willing to commit resources to respond to them as soon as possible. Hope this will reassure you about including TiDB on the list.

Here's our article about using your Go driver with TiDB: https://docs.pingcap.com/appdev/dev/for-go-sql-driver-mysql

We have a small team in Japan and we would be happy to meet up with you in-person or online to discuss how to better cooperate together on this project. Also, we will have a meetup in Japan soon and would love to invite you to it.

[methane]

@ghimsim Would you create a pull request that runs test this driver with TiDB on GitHub Action?

[coveralls]

coverage: 82.17% (-0.4%) from 82.611%
when pulling 116dda4 on crazycs520:add-tidb
into a4c260b on go-sql-driver:master.

[methane]

@crazycs520 @ghimsim I updated this PR. Would you take a look?

[coderabbitai]

Walkthrough

This update primarily focuses on enhancing the project's compatibility with various database systems, including MySQL, MariaDB, and TiDB. It also raises the minimum required Go version to 1.19. The changes aim to ensure the project remains up-to-date with current database versions and programming language standards, while also introducing specific guidelines for TiDB support and outlining maintenance expectations for the future.

Changes

File(s)	Change Summary
README.md	Updated Go version requirement to 1.19, added support for MySQL (5.7+), MariaDB (10.3+), and TiDB. Specified guidelines for TiDB support and set maintenance expectations.

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between a4c260b and 116dda4.

Files selected for processing (1)

• README.md (1 hunks)

Additional comments: 3

README.md (3)

• 44-44: The Go version requirement update to 1.19 is clear and aligns with the practice of supporting the latest three versions of Go.
• 47-49: Directing users to external resources for TiDB-related questions and documentation is helpful. Ensure the links are up-to-date and accessible.

Verification successful

---

The verification process has shown that the first link (https://docs.pingcap.com/tidb/v6.1/dev-guide-sample-application-golang) initially redirects (301 Moved Permanently) to a new location but eventually leads to a resource that returns a 200 OK status, indicating it is accessible and serving content as expected. The second link (https://ask.pingcap.com/) directly returns a 200 status, confirming its accessibility without any redirection.

Based on this information, both links are up-to-date and accessible, with the first link correctly redirecting users to the intended content. Therefore, the review comment regarding the verification of the links' accessibility and their up-to-date status is addressed successfully.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify the accessibility of external links for TiDB documentation and forum.
curl -Is https://docs.pingcap.com/tidb/v6.1/dev-guide-sample-application-golang | head -n 1
curl -Is https://ask.pingcap.com/ | head -n 1

Length of output: 185

---

---

Script:

#!/bin/bash
# Follow the redirection of the TiDB documentation link to verify its final destination.
curl -ILs https://docs.pingcap.com/tidb/v6.1/dev-guide-sample-application-golang | grep -E 'HTTP/|Location'

Length of output: 216

* 51-52: The disclaimer about support for Percona Server, Google CloudSQL, or Sphinx is clear. It sets the right expectations regarding maintainer support.

[coderabbitai]

The addition of TiDB support by PingCAP is well-documented. However, consider adding a brief overview of TiDB and why it's supported, to provide context for users unfamiliar with TiDB.