Skip to content

docs: add LibreDB Studio guide to SQL clients - #3512

Merged
bohutang merged 2 commits into
databendlabs:mainfrom
kaya-abdullah:add-libredb-studio
Oct 10, 2026
Merged

bohutang merged 2 commits into
databendlabs:mainfrom
kaya-abdullah:add-libredb-studio

Conversation

@kaya-abdullah

@kaya-abdullah kaya-abdullah commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

Adds a LibreDB Studio guide under SQL Clients, in both docs/en and docs/cn, and links it from the SQL Clients table.

LibreDB Studio (https://github.com/libredb/libredb-studio) is an MIT licensed, self-hosted web SQL editor. Its Databend connection type uses the HTTP handler (/v1/query and its next_uri pages), the same API BendSQL uses, so it connects to Databend Cloud and self-hosted Databend without the MySQL handler.

The guide covers:

  • Connecting to Databend Cloud: the DSN from the Connect dialog, port 443, verify-system, and the warehouse
  • Connecting to self-hosted Databend on port 8000
  • Browsing objects, running a query, paging through results, and Explain
  • Limitations

Verified on a Databend Cloud test tenant with one XSmall warehouse, and on self-hosted Databend (datafuselabs/databend:latest and a pinned nightly):

  • Sign-in as an SQL user over TLS with the warehouse header, including the gateway's answers to a wrong password, a missing or unknown warehouse, and a statement the user may not run
  • Result paging over next_uri, up to 100,000 rows over 10 page requests
  • Errors with their position, cancel, the server-side timeout, and an open transaction rolled back
  • Create, insert, update, delete, merge, alter and drop on Cloud, and a read-only user refused a write
  • The object browser with tables, views and materialized views, and Explain

The screenshots were taken on the Databend Cloud tenant, with the host and password masked.

Provider documentation: https://github.com/libredb/libredb-studio/blob/main/docs/providers/databend.md

@vercel

vercel Bot commented Oct 6, 2026

Copy link
Copy Markdown

@kaya-abdullah is attempting to deploy a commit to the Databend Team on Vercel.

A member of the Team first needs to authorize it.

@Chasen-Zhang
Chasen-Zhang requested a review from bohutang October 6, 2026 13:53
@vercel

vercel Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Oct 9, 2026 12:47pm UTC
docs-cn Ready Ready Preview Oct 9, 2026 12:47pm UTC

Request Review

@bohutang

bohutang commented Oct 7, 2026

Copy link
Copy Markdown
Member

Thanks for the contribution. We aim to list useful clients, not simply expand the list.

For inclusion, LibreDB Studio must have verified Databend Cloud support. Please add a dedicated guide with concrete setup, authentication, and query execution steps, plus any limitations, following the existing SQL client documentation.

A project link and self-hosted compatibility tests alone are not sufficient for us to merge this PR.

@bohutang
bohutang marked this pull request as draft October 7, 2026 15:22
@cevheri

cevheri commented Oct 8, 2026

Copy link
Copy Markdown

hi @kaya-abdullah
https://github.com/libredb/libredb-studio/blob/main/docs/providers/databend.md

@kaya-abdullah kaya-abdullah changed the title docs: add LibreDB Studio to SQL clients docs: add LibreDB Studio guide to SQL clients Oct 8, 2026
@kaya-abdullah

Copy link
Copy Markdown
Contributor Author

Thanks for the review, @bohutang. LibreDB Studio now has a Databend connection type that talks to the HTTP handler directly, the same API BendSQL uses, and it is verified on Databend Cloud.

I have replaced the table entry with a dedicated guide, in docs/en and docs/cn, following the BendSQL and DBeaver pages. It covers setup and authentication for Databend Cloud and self-hosted Databend, query execution, paging and Explain, and a Limitations section.

On a Databend Cloud test tenant we checked sign-in as an SQL user over TLS with the warehouse header, result paging over next_uri, error handling including the gateway's warehouse and permission refusals, cancel and timeouts, and full read and write. The screenshots in the guide were taken on that tenant.

The provider documentation, with the full behaviour and test details, is at https://github.com/libredb/libredb-studio/blob/main/docs/providers/databend.md

Thanks to @cevheri for building the Databend connection type and for running the Databend Cloud tests behind this guide.

@bohutang

bohutang commented Oct 9, 2026 •

Copy link
Copy Markdown
Member

Thanks for adding Databend support! I tested LibreDB Studio against Databend Cloud, and the connection, queries, pagination, and EXPLAIN all worked well.

One small UI suggestion: could you replace the generic warehouse icon next to Databend on the login page with an official Databend icon from our brand assets? The icon-only version would fit nicely alongside the other database icons. Thanks!

Screenshot highlighting the current Databend icon:

LibreDB Studio login page highlighting the current Databend icon

cevheri added a commit to libredb/libredb-studio that referenced this pull request Oct 9, 2026
Databend's engine icon is now the official icon-only mark from the Databend brand assets ("Icon · Light", https://www.databend.com/brand/), replacing the warehouse drawn for Studio, as the Databend team asked in databendlabs/databend-docs#3512.

The brand guidelines ask for the original colours and proportions, so it is the one engine icon with fixed fills: the published paths and colours are unchanged and the accent class a surface passes no longer repaints it. Only the viewBox is new, a square around the mark's bounds.

The icon test pins the paths and colours to the published file and exempts this icon from the 1.5 stroke-weight contract.
cevheri added a commit to libredb/libredb-studio that referenced this pull request Oct 9, 2026
…ider fixes

Carries Databend's official icon at the Databend team's request
(databendlabs/databend-docs#3512), new connections that start unlabelled
(#1604), Generate Test Data that leaves foreign keys out and keeps unique
values distinct (#1610), Source tabs that re-read (#1594), a forty-fifth
agent model (#1624) and fixes across PostgreSQL and its relatives, the
wire-compatible engines, Vitess, MongoDB, Redis and Oracle.

No security fix. Chart 0.1.81 tracks the release with no template or value
change; the operator bundle and the CapRover templates move to 0.18.2.
@cevheri

cevheri commented Oct 9, 2026

Copy link
Copy Markdown

Hi @bohutang thanks for review and test. changed databend logo. 0.18.2 version released, you can check demo environment: https://app.libredb.org/login

image

@bohutang
bohutang merged commit 1f3d469 into databendlabs:main Oct 10, 2026
5 checks passed

This branch was successfully deployed

2 active deployments
Preview – docs-cn — 86216660 Deployed Oct 9, 2026 by vercel[bot]
Preview – docs — 86216660 Deployed Oct 9, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants