Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/ecosystem/sql-clients/libredb-studio.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: LibreDB Studio
---

# LibreDB Studio

[LibreDB Studio](https://libredb.org) is an open source, web-based SQL IDE with a query editor, an object browser, and a monitoring dashboard. It supports seventeen database engines, including PostgreSQL, MySQL, Oracle, and ClickHouse, from a single workspace. It connects to Apache Cloudberry over the PostgreSQL wire protocol, the same way it connects to PostgreSQL itself.

## Prerequisites

- Apache Cloudberry is deployed with proper database access permissions set in `pg_hba.conf`. These steps were verified against Apache Cloudberry 2.1.0-incubating.
- LibreDB Studio is installed and running. It is not a desktop download: run it as a container, a Helm chart, or with `npx @libredb/studio`.
- The coordinator host, port, database name, and a role to connect as.

## Steps

1. Open LibreDB Studio in your browser and sign in.

2. Click the **+** button next to the LibreDB Studio logo to open the New Connection dialog.

3. Name the connection and select **PostgreSQL** as the connection type. Cloudberry has no separate connection type of its own: it speaks the PostgreSQL wire protocol, so the PostgreSQL driver is the correct choice.
![](../../media/libredb-studio1.png)

4. Fill in the coordinator host and port, along with your username, password, and database name.
![](../../media/libredb-studio2.png)

5. Click **Test Connection** to verify, then **Establish Connection**.

The connection appears in the sidebar, with the object browser on the left. Two internal tables, `pg_ext_aux.pg_pax_fastsequence` and `pg_ext_aux.pg_pax_tables`, are listed alongside your own tables.
![](../../media/libredb-studio3.png)

You can now browse schemas and run queries, including joins and aggregates, from the editor.
![](../../media/libredb-studio4.png)
Binary file added docs/media/libredb-studio1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/libredb-studio2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/libredb-studio3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/libredb-studio4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ const sidebars: SidebarsConfig = {
{
type: 'category',
label: 'SQL Clients',
items: ['ecosystem/sql-clients/dbeaver', 'ecosystem/sql-clients/clouddm']
items: ['ecosystem/sql-clients/dbeaver', 'ecosystem/sql-clients/clouddm', 'ecosystem/sql-clients/libredb-studio']
},
{
type: 'category',
Expand Down
33 changes: 33 additions & 0 deletions versioned_docs/version-2.x/ecosystem/sql-clients/libredb-studio.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: LibreDB Studio
---

# LibreDB Studio

[LibreDB Studio](https://libredb.org) is an open source, web-based SQL IDE with a query editor, an object browser, and a monitoring dashboard. It supports seventeen database engines, including PostgreSQL, MySQL, Oracle, and ClickHouse, from a single workspace. It connects to Apache Cloudberry over the PostgreSQL wire protocol, the same way it connects to PostgreSQL itself.

## Prerequisites

- Apache Cloudberry is deployed with proper database access permissions set in `pg_hba.conf`. These steps were verified against Apache Cloudberry 2.1.0-incubating.
- LibreDB Studio is installed and running. It is not a desktop download: run it as a container, a Helm chart, or with `npx @libredb/studio`.
- The coordinator host, port, database name, and a role to connect as.

## Steps

1. Open LibreDB Studio in your browser and sign in.

2. Click the **+** button next to the LibreDB Studio logo to open the New Connection dialog.

3. Name the connection and select **PostgreSQL** as the connection type. Cloudberry has no separate connection type of its own: it speaks the PostgreSQL wire protocol, so the PostgreSQL driver is the correct choice.
![](../../media/libredb-studio1.png)

4. Fill in the coordinator host and port, along with your username, password, and database name.
![](../../media/libredb-studio2.png)

5. Click **Test Connection** to verify, then **Establish Connection**.

The connection appears in the sidebar, with the object browser on the left. Two internal tables, `pg_ext_aux.pg_pax_fastsequence` and `pg_ext_aux.pg_pax_tables`, are listed alongside your own tables.
![](../../media/libredb-studio3.png)

You can now browse schemas and run queries, including joins and aggregates, from the editor.
![](../../media/libredb-studio4.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion versioned_sidebars/version-2.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@
"label": "SQL Clients",
"items": [
"ecosystem/sql-clients/dbeaver",
"ecosystem/sql-clients/clouddm"
"ecosystem/sql-clients/clouddm",
"ecosystem/sql-clients/libredb-studio"
]
},
{
Expand Down
Loading