[LyJacky]

First-time contributors' checklist

• I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

What is changed, added, or deleted? (Required)

Adds "Connect to TiDB with VisuaLeaf" (develop/dev-guide-gui-visualeaf.md), following
the structure of the other GUI guides, plus:

• a row in the GUI table in develop/dev-guide-third-party-support.md
• a TOC entry in TOC-develop.md
• 4 screenshots in media/develop/

VisuaLeaf is a cross-platform desktop database client (Windows, macOS, Linux) with a
dedicated TiDB connection type. The steps and screenshots were verified against TiDB v8.5.3.

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)

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

• Related code change PR links: N/A

Summary by CodeRabbit

• Documentation
  • Added a tutorial for connecting to TiDB Self-Managed with VisuaLeaf, configuring and testing the connection, and running SQL queries.
  • Added VisuaLeaf to the GUI support table with its tested version and support level, and linked to the tutorial from the guides table of contents.

[ti-chi-bot]

Welcome @LyJacky!

It looks like this is your first PR to pingcap/docs 🎉.

I'm the bot to help you request reviewers, add labels and more, See available commands.

We want to make sure your contribution gets all the attention it needs!



Thank you, and welcome to pingcap/docs. 😃

[ti-chi-bot]

Hi @LyJacky. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[ti-chi-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign qiancai for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

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

Details

Needs approval from an approver in each of these files:

• OWNERS

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

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: Repository: pingcap/docs/.coderabbit.yaml
• Review profile: ASSERTIVE
• Plan: Advanced
• Run ID: 0d04e244-212d-4474-a564-bd47466389e4

---

---

📥 Commits

Reviewing files that changed from the base of the PR and between 24da15d and 80b7b8f.

---

---

⛔ Files ignored due to path filters (4)

• media/develop/visualeaf-connected-query.png is excluded by !**/*.png
• media/develop/visualeaf-connection-settings.png is excluded by !**/*.png
• media/develop/visualeaf-new-connection.png is excluded by !**/*.png
• media/develop/visualeaf-select-tidb.png is excluded by !**/*.png

---

---

📒 Files selected for processing (3)

• TOC-develop.md
• develop/dev-guide-gui-visualeaf.md
• develop/dev-guide-third-party-support.md

---

---

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

---

---

---

📝 Walkthrough

📝 Walkthrough

Walkthrough

The documentation adds a VisuaLeaf tutorial for connecting to TiDB Self-Managed. The guide index links to the tutorial, and the GUI support table lists VisuaLeaf version 1.0.2473 as Full support.

Changes

VisuaLeaf documentation

Layer / File(s)	Summary
Connection tutorial and documentation links develop/dev-guide-gui-visualeaf.md, develop/dev-guide-third-party-support.md, TOC-develop.md	The tutorial covers prerequisites, connection setup, testing, SQL execution, and support resources. The support table lists version 1.0.2473 as Full support, and the table of contents links to the tutorial.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

---

---

Merge Risk: ⚪ Minimal · up to 80b7b

No actionable defect is established in the VisuaLeaf guide or its index entries. The change is mergeable after normal documentation checks.

Security Architecture Review

Security architecture risk: 🔵 Low · up to 80b7b

The connection guidance leaves encryption and server-identity protections unverified for remote self-managed connections. No insecure connection or runtime configuration change has been demonstrated.

Retained concerns

• Low · security · inferred: The new instructions may be followed for remote or production self-managed connections without an established transport-security or server-identity requirement. Actual exposure depends on unverified client defaults and deployment controls; insecure transmission is not established.

Security review details

Security Blast Radius

• inferred — Conditional exposure concerns authentication material and SQL traffic for the selected self-managed connection, with downstream authority determined by the account's actual privileges. The required tutorial privileges do not establish that the account lacks broader access. Cloud exposure and cross-tenant escalation are not demonstrated.

Security Findings and Attack Paths

• inferred — A network adversary could threaten authentication or SQL traffic if the connection permits unprotected transport or unauthenticated server identity. Those prerequisites remain unverified: the canonical assessment retains no Security findings and defers this candidate pending evidence of VisuaLeaf's TLS behavior.

Trust Boundaries and Controls

• observed — The unresolved boundary is between the desktop client and the selected TiDB server. Resolving it requires version-specific evidence of TLS negotiation, certificate and hostname validation, enforcement settings, and behavior when protection cannot be established. The documented Test Connection step establishes functional success, not these security properties.

---

Pre-merge checks | 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage		No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.
Description check		The description explains the new VisuaLeaf guide, related documentation updates, screenshots, verification version, and target branch. The AI involvement and additional checklist sections are not incl…
Title check		The title is concise and identifies the main change: adding VisuaLeaf documentation. It could use the product's capitalization, but it clearly describes the pull request.

---

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create a new PR

---

---

---

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

---

_{Comment @coderabbitai help to get the list of available commands.}

[LyJacky]

/assign @qiancai