diff --git a/docs/ecosystem/sql-clients/visualeaf.md b/docs/ecosystem/sql-clients/visualeaf.md new file mode 100644 index 0000000000..689ced6233 --- /dev/null +++ b/docs/ecosystem/sql-clients/visualeaf.md @@ -0,0 +1,33 @@ +--- +title: VisuaLeaf +--- + +# VisuaLeaf + +[VisuaLeaf](https://visualeaf.com/) is a desktop database client for Windows, macOS, and Linux, with a SQL editor, a results grid, a visual query builder, entity-relationship diagrams, and charts built from query results. It is available as a free Community Edition and in paid editions. It connects to Apache Cloudberry over the PostgreSQL wire protocol using its PostgreSQL connection type, 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. +- [VisuaLeaf](https://visualeaf.com/download) is installed. +- The coordinator host, port (5432 by default), database name, and a role to connect as. + +## Steps + +1. Launch VisuaLeaf and click **New Connection**. + +2. Search for "PostgreSQL" and select **PostgreSQL**. Cloudberry has no separate connection type of its own: it speaks the PostgreSQL wire protocol, so the PostgreSQL connection type is the correct choice. +![](../../media/visualeaf1.png) + +3. Name the connection, then fill in the coordinator host and port, the database name, your username (for example, `gpadmin`), and password. +![](../../media/visualeaf2.png) + +4. Click **Test Connection** to verify, then **Save & Connect**. + +5. Expand the connection in the **Connections** sidebar. It lists the databases, schemas, tables, views, sequences, and procedures. +![](../../media/visualeaf3.png) + +6. Right-click a database and select **New SQL Editor**. Click **Run All** (F5) to run the whole script, or select part of it and click **Run** (F9) to run only the selection. Results appear in the grid below the editor. +![](../../media/visualeaf4.png) + +You can now browse schemas and run queries, including joins and aggregates, from the editor. diff --git a/docs/media/visualeaf1.png b/docs/media/visualeaf1.png new file mode 100644 index 0000000000..818990e658 Binary files /dev/null and b/docs/media/visualeaf1.png differ diff --git a/docs/media/visualeaf2.png b/docs/media/visualeaf2.png new file mode 100644 index 0000000000..7cee20e03d Binary files /dev/null and b/docs/media/visualeaf2.png differ diff --git a/docs/media/visualeaf3.png b/docs/media/visualeaf3.png new file mode 100644 index 0000000000..4e8b0bfe7c Binary files /dev/null and b/docs/media/visualeaf3.png differ diff --git a/docs/media/visualeaf4.png b/docs/media/visualeaf4.png new file mode 100644 index 0000000000..8d50e3dfe9 Binary files /dev/null and b/docs/media/visualeaf4.png differ diff --git a/sidebars.ts b/sidebars.ts index c7b65ea5b2..19aa395de2 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', 'ecosystem/sql-clients/libredb-studio', 'ecosystem/sql-clients/tabularis'] + items: ['ecosystem/sql-clients/dbeaver', 'ecosystem/sql-clients/clouddm', 'ecosystem/sql-clients/libredb-studio', 'ecosystem/sql-clients/tabularis', 'ecosystem/sql-clients/visualeaf'] }, { type: 'category', diff --git a/versioned_docs/version-2.x/ecosystem/sql-clients/visualeaf.md b/versioned_docs/version-2.x/ecosystem/sql-clients/visualeaf.md new file mode 100644 index 0000000000..689ced6233 --- /dev/null +++ b/versioned_docs/version-2.x/ecosystem/sql-clients/visualeaf.md @@ -0,0 +1,33 @@ +--- +title: VisuaLeaf +--- + +# VisuaLeaf + +[VisuaLeaf](https://visualeaf.com/) is a desktop database client for Windows, macOS, and Linux, with a SQL editor, a results grid, a visual query builder, entity-relationship diagrams, and charts built from query results. It is available as a free Community Edition and in paid editions. It connects to Apache Cloudberry over the PostgreSQL wire protocol using its PostgreSQL connection type, 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. +- [VisuaLeaf](https://visualeaf.com/download) is installed. +- The coordinator host, port (5432 by default), database name, and a role to connect as. + +## Steps + +1. Launch VisuaLeaf and click **New Connection**. + +2. Search for "PostgreSQL" and select **PostgreSQL**. Cloudberry has no separate connection type of its own: it speaks the PostgreSQL wire protocol, so the PostgreSQL connection type is the correct choice. +![](../../media/visualeaf1.png) + +3. Name the connection, then fill in the coordinator host and port, the database name, your username (for example, `gpadmin`), and password. +![](../../media/visualeaf2.png) + +4. Click **Test Connection** to verify, then **Save & Connect**. + +5. Expand the connection in the **Connections** sidebar. It lists the databases, schemas, tables, views, sequences, and procedures. +![](../../media/visualeaf3.png) + +6. Right-click a database and select **New SQL Editor**. Click **Run All** (F5) to run the whole script, or select part of it and click **Run** (F9) to run only the selection. Results appear in the grid below the editor. +![](../../media/visualeaf4.png) + +You can now browse schemas and run queries, including joins and aggregates, from the editor. diff --git a/versioned_docs/version-2.x/media/visualeaf1.png b/versioned_docs/version-2.x/media/visualeaf1.png new file mode 100644 index 0000000000..818990e658 Binary files /dev/null and b/versioned_docs/version-2.x/media/visualeaf1.png differ diff --git a/versioned_docs/version-2.x/media/visualeaf2.png b/versioned_docs/version-2.x/media/visualeaf2.png new file mode 100644 index 0000000000..7cee20e03d Binary files /dev/null and b/versioned_docs/version-2.x/media/visualeaf2.png differ diff --git a/versioned_docs/version-2.x/media/visualeaf3.png b/versioned_docs/version-2.x/media/visualeaf3.png new file mode 100644 index 0000000000..4e8b0bfe7c Binary files /dev/null and b/versioned_docs/version-2.x/media/visualeaf3.png differ diff --git a/versioned_docs/version-2.x/media/visualeaf4.png b/versioned_docs/version-2.x/media/visualeaf4.png new file mode 100644 index 0000000000..8d50e3dfe9 Binary files /dev/null and b/versioned_docs/version-2.x/media/visualeaf4.png differ diff --git a/versioned_sidebars/version-2.x-sidebars.json b/versioned_sidebars/version-2.x-sidebars.json index 194721314e..2cb132628b 100644 --- a/versioned_sidebars/version-2.x-sidebars.json +++ b/versioned_sidebars/version-2.x-sidebars.json @@ -375,7 +375,8 @@ "ecosystem/sql-clients/dbeaver", "ecosystem/sql-clients/clouddm", "ecosystem/sql-clients/libredb-studio", - "ecosystem/sql-clients/tabularis" + "ecosystem/sql-clients/tabularis", + "ecosystem/sql-clients/visualeaf" ] }, {