diff --git a/docs/ecosystem/sql-clients/libredb-studio.md b/docs/ecosystem/sql-clients/libredb-studio.md new file mode 100644 index 0000000000..1262e1e9a0 --- /dev/null +++ b/docs/ecosystem/sql-clients/libredb-studio.md @@ -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) diff --git a/docs/media/libredb-studio1.png b/docs/media/libredb-studio1.png new file mode 100644 index 0000000000..b9de234b60 Binary files /dev/null and b/docs/media/libredb-studio1.png differ diff --git a/docs/media/libredb-studio2.png b/docs/media/libredb-studio2.png new file mode 100644 index 0000000000..b4dadab933 Binary files /dev/null and b/docs/media/libredb-studio2.png differ diff --git a/docs/media/libredb-studio3.png b/docs/media/libredb-studio3.png new file mode 100644 index 0000000000..013f0c50a8 Binary files /dev/null and b/docs/media/libredb-studio3.png differ diff --git a/docs/media/libredb-studio4.png b/docs/media/libredb-studio4.png new file mode 100644 index 0000000000..9f2fb75959 Binary files /dev/null and b/docs/media/libredb-studio4.png differ diff --git a/sidebars.ts b/sidebars.ts index bd6e562ffd..4a6e920461 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -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', diff --git a/versioned_docs/version-2.x/ecosystem/sql-clients/libredb-studio.md b/versioned_docs/version-2.x/ecosystem/sql-clients/libredb-studio.md new file mode 100644 index 0000000000..1262e1e9a0 --- /dev/null +++ b/versioned_docs/version-2.x/ecosystem/sql-clients/libredb-studio.md @@ -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) diff --git a/versioned_docs/version-2.x/media/libredb-studio1.png b/versioned_docs/version-2.x/media/libredb-studio1.png new file mode 100644 index 0000000000..b9de234b60 Binary files /dev/null and b/versioned_docs/version-2.x/media/libredb-studio1.png differ diff --git a/versioned_docs/version-2.x/media/libredb-studio2.png b/versioned_docs/version-2.x/media/libredb-studio2.png new file mode 100644 index 0000000000..b4dadab933 Binary files /dev/null and b/versioned_docs/version-2.x/media/libredb-studio2.png differ diff --git a/versioned_docs/version-2.x/media/libredb-studio3.png b/versioned_docs/version-2.x/media/libredb-studio3.png new file mode 100644 index 0000000000..013f0c50a8 Binary files /dev/null and b/versioned_docs/version-2.x/media/libredb-studio3.png differ diff --git a/versioned_docs/version-2.x/media/libredb-studio4.png b/versioned_docs/version-2.x/media/libredb-studio4.png new file mode 100644 index 0000000000..9f2fb75959 Binary files /dev/null and b/versioned_docs/version-2.x/media/libredb-studio4.png differ diff --git a/versioned_sidebars/version-2.x-sidebars.json b/versioned_sidebars/version-2.x-sidebars.json index 2f38e7af4c..ff5aa652e5 100644 --- a/versioned_sidebars/version-2.x-sidebars.json +++ b/versioned_sidebars/version-2.x-sidebars.json @@ -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" ] }, {