Skip to content

Add a connection tutorial for LibreDB Studio - #23659

Open
kaya-abdullah wants to merge 5 commits into
pingcap:masterfrom
kaya-abdullah:add-libredb-studio-gui-tutorial
Open

Add a connection tutorial for LibreDB Studio#23659
kaya-abdullah wants to merge 5 commits into
pingcap:masterfrom
kaya-abdullah:add-libredb-studio-gui-tutorial

Conversation

@kaya-abdullah

@kaya-abdullah kaya-abdullah commented Aug 28, 2026

Copy link
Copy Markdown

First-time contributors' checklist

What is changed, added or deleted? (Required)

Adds a connection tutorial for LibreDB Studio, following on from #23658 which added it to the GUI table with the Tutorial column left as N/A. This updates that cell to point to the new page, matching the pattern DataGrip, DBeaver, VS Code and Navicat already have.

LibreDB Studio (https://libredb.org) is an open-source, web-based SQL IDE that connects to TiDB over the MySQL protocol. The tutorial was written and verified against a local TiDB Self-Managed instance (pingcap/tidb:v8.5.0, --store=unistore): created a connection, ran Test Connection, then created a table, inserted rows and queried them back. Screenshots are from that session.

The tutorial only covers TiDB Self-Managed. I don't have a TiDB Cloud account to verify the Starter/Essential/Premium/Dedicated connection dialogs, so I left those out rather than guess at them.

Changed/added files:

  • develop/dev-guide-third-party-support.md: Tutorial cell for the LibreDB Studio row updated from N/A to the new page.
  • TOC-develop.md: one entry added under CLI & GUI Tools.
  • develop/dev-guide-gui-libredb-studio.md: new tutorial page.
  • media/develop/libredb-studio-*.png: four screenshots referenced by the tutorial.

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)?

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

Summary by CodeRabbit

  • New Documentation
    • Added a guide for connecting to TiDB using LibreDB Studio, including setup prerequisites, connection steps, testing, and SSL guidance for TiDB Cloud.
    • Added LibreDB Studio to the supported third-party GUI tools list with full support for version 0.13.4.
    • Added the new guide to the documentation table of contents.

@ti-chi-bot ti-chi-bot Bot added area/develop This PR relates to the area of TiDB App development. contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. labels Aug 28, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 28, 2026

Copy link
Copy Markdown

Hi @kaya-abdullah. 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 ti-chi-bot Bot added the needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. label Aug 28, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 28, 2026

Copy link
Copy Markdown

[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 kissmydb 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:

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 missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 28, 2026
@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Adds a LibreDB Studio connection guide for TiDB. Links the guide from the development table of contents and the third-party GUI support table.

Changes

LibreDB Studio documentation

Layer / File(s) Summary
Document LibreDB Studio support and connection flow
develop/dev-guide-gui-libredb-studio.md, TOC-develop.md, develop/dev-guide-third-party-support.md
Adds prerequisites, connection steps, TiDB-specific notes, navigation, and a support entry for LibreDB Studio version 0.13.4.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: 🟡 Moderate · up to b04b1

The tutorial currently omits required TLS guidance for secure Self-Managed clusters, may not complete its multi-statement verification flow as written, and claims broader support than the demonstrated scope. Merge is not ready until these bounded documentation issues are fixed or explicitly accepted.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding a LibreDB Studio connection tutorial.
Description check ✅ Passed The description covers the required sections, explains the changes, identifies affected TiDB versions, provides references, records AI involvement, and addresses applicable change categories.
Docstring Coverage ✅ Passed 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 ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

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 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 4


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 3d5867dd-96b0-46f7-a508-3e0bfaf2bad3

📥 Commits

Reviewing files that changed from the base of the PR and between 0d5953c and 5df0aaa.

⛔ Files ignored due to path filters (4)
  • media/develop/libredb-studio-connected-query.png is excluded by !**/*.png
  • media/develop/libredb-studio-connection-settings.png is excluded by !**/*.png
  • media/develop/libredb-studio-mysql-compatibility-note.png is excluded by !**/*.png
  • media/develop/libredb-studio-new-connection.png is excluded by !**/*.png
📒 Files selected for processing (3)
  • TOC-develop.md
  • develop/dev-guide-gui-libredb-studio.md
  • develop/dev-guide-third-party-support.md

Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.

Comment thread develop/dev-guide-gui-libredb-studio.md Outdated
Comment thread develop/dev-guide-gui-libredb-studio.md Outdated
Comment thread develop/dev-guide-gui-libredb-studio.md
Comment thread develop/dev-guide-third-party-support.md
@kaya-abdullah

Copy link
Copy Markdown
Author

@coderabbitai review

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 5cd3e29d-9074-48a7-8ecf-701b054560e0

📥 Commits

Reviewing files that changed from the base of the PR and between 5df0aaa and 4806f60.

📒 Files selected for processing (1)
  • develop/dev-guide-gui-libredb-studio.md

Included review availability: Your plan provides up to 4 included reviews per hour; 1 remains after this review.

Comment thread develop/dev-guide-gui-libredb-studio.md
@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown
⚠️ Action not completed

Already reviewed the last commit. Use @coderabbitai full review to rerun a review of the entire changeset.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
develop/dev-guide-gui-libredb-studio.md (2)

30-30: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Document the LibreDB Studio login credentials.

For a zero-config start, use admin@libredb.org and the admin password printed once in the LibreDB Studio server log.

Suggested replacement
1. Open LibreDB Studio in your browser and sign in. For a zero-config start, use `admin@libredb.org` and the admin password printed once in the LibreDB Studio server log.

Sources: Path instructions, MCP tools


40-50: 🔒 Security & Privacy | 🟠 Major | 🏗️ Heavy lift

Document the TLS path for Self-Managed clusters.

The form defaults to SSL Mode: disable. If TiDB enforces require_secure_transport, REQUIRE SSL, or REQUIRE X509, Test Connection fails with the documented settings. Add the SSL / TLS steps, including require, CA verification, and client certificate/key configuration, and update the screenshot. Otherwise, limit this tutorial to an insecure local test cluster.

Sources: Path instructions, MCP tools


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 6e4d9c93-41ed-42d7-b210-3ad2d94bea44

📥 Commits

Reviewing files that changed from the base of the PR and between 4806f60 and b04b10e.

📒 Files selected for processing (1)
  • develop/dev-guide-gui-libredb-studio.md

Included review availability: Your plan provides up to 4 included reviews per hour; 0 remain after this review.

Comment thread develop/dev-guide-gui-libredb-studio.md Outdated
Comment thread develop/dev-guide-gui-libredb-studio.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/develop This PR relates to the area of TiDB App development. contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. missing-translation-status This PR does not have translation status info. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant