GUI clients
This page documents the preview (v2.21) version. Preview includes features under active development and is for development and testing only. For production, use the stable (v2024.1) version.
Because YugabyteDB is compatible with PostgreSQL and Cassandra, you can use third-party clients to connect to your YugabyteDB clusters.
Tools
YugabyteDB prerequisites
To use these tools with YugabyteDB, you should have a cluster up and running, and you will need to know the connection parameters required by the client to connect to your cluster.
To create a local cluster, follow the steps in Quick start.
To create a cluster in YugabyteDB Aeon, follow the steps in Create a cluster. In addition, do the following:
- Download the cluster certificate; YugabyteDB Aeon requires the use of TLS
- Add your computer to the cluster IP allow list; this allows your computer to access the cluster
Connection parameters
To connect, follow the client's configuration steps, and use the following values:
| Setting | Local installation | YugabyteDB Aeon |
|---|---|---|
| Hostname | localhost or the IP address of a node |
The cluster hostname as displayed on the cluster Settings tab |
| Port | 5433 (YSQL) 9042 (YCQL) |
5433 (YSQL) 9042 (YCQL) |
| Database | Database name (yugabyte is the default) |
Database name (yugabyte is the default) |
| Username | yugabyte or cassandra |
Database username (admin is the default) |
| Password | yugabyte or cassandraLeave blank if authentication is not enabled |
Database user password |
YugabyteDB Aeon requires TLS. Use the root.ca certificate you downloaded for connections to YugabyteDB Aeon clusters.
SQL Workbench/J