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
29 changes: 29 additions & 0 deletions docs/ecosystem/sql-clients/tabularis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Tabularis
---

# Tabularis

[Tabularis](https://tabularis.dev) is an open source desktop SQL workspace for Windows, macOS, and Linux, with a schema explorer, a SQL editor, visual `EXPLAIN`, entity-relationship diagrams, and SQL notebooks. It connects to Apache Cloudberry over the PostgreSQL wire protocol using its built-in PostgreSQL driver, the same way it connects to PostgreSQL itself.

## Prerequisites

- Apache Cloudberry is deployed with proper database access permissions set in `pg_hba.conf`.
- [Tabularis](https://github.com/TabularisDB/tabularis/releases) (v0.24.0 or higher) is installed. Packages are available through WinGet, Homebrew, Snap, Flatpak, and the AUR.
- The coordinator host, port, database name, and a role to connect as.

## Steps

1. Launch Tabularis and click **Add Connection** in the connection manager.

2. Under **Database type**, select **PostgreSQL**. Cloudberry has no separate connection type of its own: it speaks the PostgreSQL wire protocol, so the PostgreSQL driver is the correct choice.

3. Name the connection, then fill in the coordinator host and port, your username, password, and database name. You can also paste a connection string such as `postgresql://gpadmin:password@coordinator-host:5432/postgres` into the **Connection string** field to fill these in at once.

4. Click **Test Connection** to verify, then **Save**.

5. Open the connection from the connection manager. The schema explorer on the left lists schemas, tables, views, and routines; the editor on the right runs queries and shows results in the data grid.

![](../../media/tabularis1.png)

You can now browse schemas, edit rows inline, and run queries, including joins and aggregates, from the editor.
Binary file added docs/media/tabularis1.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']
items: ['ecosystem/sql-clients/dbeaver', 'ecosystem/sql-clients/clouddm', 'ecosystem/sql-clients/libredb-studio', 'ecosystem/sql-clients/tabularis']
},
{
type: 'category',
Expand Down
29 changes: 29 additions & 0 deletions versioned_docs/version-2.x/ecosystem/sql-clients/tabularis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Tabularis
---

# Tabularis

[Tabularis](https://tabularis.dev) is an open source desktop SQL workspace for Windows, macOS, and Linux, with a schema explorer, a SQL editor, visual `EXPLAIN`, entity-relationship diagrams, and SQL notebooks. It connects to Apache Cloudberry over the PostgreSQL wire protocol using its built-in PostgreSQL driver, the same way it connects to PostgreSQL itself.

## Prerequisites

- Apache Cloudberry is deployed with proper database access permissions set in `pg_hba.conf`.
- [Tabularis](https://github.com/TabularisDB/tabularis/releases) (v0.24.0 or higher) is installed. Packages are available through WinGet, Homebrew, Snap, Flatpak, and the AUR.
- The coordinator host, port, database name, and a role to connect as.

## Steps

1. Launch Tabularis and click **Add Connection** in the connection manager.

2. Under **Database type**, select **PostgreSQL**. Cloudberry has no separate connection type of its own: it speaks the PostgreSQL wire protocol, so the PostgreSQL driver is the correct choice.

3. Name the connection, then fill in the coordinator host and port, your username, password, and database name. You can also paste a connection string such as `postgresql://gpadmin:password@coordinator-host:5432/postgres` into the **Connection string** field to fill these in at once.

4. Click **Test Connection** to verify, then **Save**.

5. Open the connection from the connection manager. The schema explorer on the left lists schemas, tables, views, and routines; the editor on the right runs queries and shows results in the data grid.

![](../../media/tabularis1.png)

You can now browse schemas, edit rows inline, and run queries, including joins and aggregates, from the editor.
Binary file added versioned_docs/version-2.x/media/tabularis1.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 @@ -374,7 +374,8 @@
"items": [
"ecosystem/sql-clients/dbeaver",
"ecosystem/sql-clients/clouddm",
"ecosystem/sql-clients/libredb-studio"
"ecosystem/sql-clients/libredb-studio",
"ecosystem/sql-clients/tabularis"
]
},
{
Expand Down
Loading