Skip to content
Open
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/visualeaf.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added docs/media/visualeaf1.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/visualeaf2.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/visualeaf3.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/visualeaf4.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', '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',
Expand Down
33 changes: 33 additions & 0 deletions versioned_docs/version-2.x/ecosystem/sql-clients/visualeaf.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added versioned_docs/version-2.x/media/visualeaf1.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 versioned_docs/version-2.x/media/visualeaf2.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 versioned_docs/version-2.x/media/visualeaf3.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 versioned_docs/version-2.x/media/visualeaf4.png
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 @@ -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"
]
},
{
Expand Down
Loading