diff --git a/content/clients/tools/_index.md b/content/clients/tools/_index.md index 046f6d36..248ed4d0 100644 --- a/content/clients/tools/_index.md +++ b/content/clients/tools/_index.md @@ -12,3 +12,4 @@ are not tied to a specific programming language. * [DBeaver](./dbeaver) — cross-platform SQL GUI * [Grafana](./grafana) — observability dashboards backed by CedarDB * [psql](./psql) — the standard PostgreSQL command-line client +* [VisuaLeaf](./visualeaf) — cross-platform desktop SQL client diff --git a/content/clients/tools/visualeaf.md b/content/clients/tools/visualeaf.md new file mode 100644 index 00000000..082a245c --- /dev/null +++ b/content/clients/tools/visualeaf.md @@ -0,0 +1,60 @@ +--- +title: "VisuaLeaf" +linkTitle: "VisuaLeaf" +weight: 100 +--- + +You can connect to CedarDB using [VisuaLeaf](https://visualeaf.com/), a cross-platform desktop database client for +Windows, macOS, and Linux. VisuaLeaf connects to CedarDB through its PostgreSQL connection type, so you can browse your +schema, run SQL queries, and view the results in a grid. It offers a free Community Edition as well as paid editions. + +## Set up VisuaLeaf + +{{% steps %}} + +### Install VisuaLeaf + +Install VisuaLeaf from its [download page](https://visualeaf.com/download). + +### Add a CedarDB connection + +After starting VisuaLeaf, click **New Connection** on the welcome screen to open the database picker. + +VisuaLeaf database picker + +CedarDB speaks the PostgreSQL wire protocol, so search for `PostgreSQL` and select the **PostgreSQL** card. + +selecting the PostgreSQL connection type + +In the next screen, enter your CedarDB connection settings: host, port (`5432` by default), database, user, and +password. + +CedarDB connection settings + +### Test the connection + +You can test the connection with the **Test Connection** button, which verifies your connection credentials. +When everything is correct, the test completes successfully. Then click **Save & Connect**. + +successful connection test + +{{% /steps %}} + +## Features + +This is a brief overview of the features you can use with VisuaLeaf. + +### Schema + +The new connection appears in the **Connections** sidebar. Expand it to see the schemas of your database with their +tables, views, sequences, and procedures. + +![schema overview](/images/visualeaf/5_object_tree.png) + +### Queries + +To write SQL queries, right-click the database and choose **New SQL Editor**. +In this editor, you can enter SQL scripts and run them against CedarDB with **Run All** (F5) or run only the +selected text with **Run** (F9). Results are shown in a grid below the editor. + +![query results](/images/visualeaf/6_query_results.png) diff --git a/static/images/visualeaf/1_new_connection.png b/static/images/visualeaf/1_new_connection.png new file mode 100644 index 00000000..cc55ef16 Binary files /dev/null and b/static/images/visualeaf/1_new_connection.png differ diff --git a/static/images/visualeaf/2_select_postgresql.png b/static/images/visualeaf/2_select_postgresql.png new file mode 100644 index 00000000..818990e6 Binary files /dev/null and b/static/images/visualeaf/2_select_postgresql.png differ diff --git a/static/images/visualeaf/3_connection_form.png b/static/images/visualeaf/3_connection_form.png new file mode 100644 index 00000000..9c669ff9 Binary files /dev/null and b/static/images/visualeaf/3_connection_form.png differ diff --git a/static/images/visualeaf/4_test_connection.png b/static/images/visualeaf/4_test_connection.png new file mode 100644 index 00000000..6595d522 Binary files /dev/null and b/static/images/visualeaf/4_test_connection.png differ diff --git a/static/images/visualeaf/5_object_tree.png b/static/images/visualeaf/5_object_tree.png new file mode 100644 index 00000000..8e0932f0 Binary files /dev/null and b/static/images/visualeaf/5_object_tree.png differ diff --git a/static/images/visualeaf/6_query_results.png b/static/images/visualeaf/6_query_results.png new file mode 100644 index 00000000..7df09e7b Binary files /dev/null and b/static/images/visualeaf/6_query_results.png differ