Compose for MySQL Tools

There is a wide-variety of tools available to extend the functionality of Compose for MySQL. Many of them complementary and connectable to Compose. While the Compose does not currently have a data browser, there are a couple of GUIs that work with your Compose for MySQL deployments. This page has instructions for some, but this not an exhaustive list of what is compatible.

Note: As Compose for MySQL defaults to using TLS/SSL, all examples will include basic TLS/SSL enabling options.

MySQL Workbench

MySQL Workbench is an open-source tool for visualizing and managing MySQL from Oracle. You can download the appropriate version for your platform from MySQL developer's site. Once it is installed you will need one of the connection strings from your Compose for MySQL deployment to connect.

On the Welcome screen, click on the Add button next to MySQL Connections. You will want to fill in the hostname and port with the information from your deployment's connection string, as well as the deployment's credentials information.

Sample connection settings to a Compose deployment.Sample connection settings to a Compose deployment.

Sample connection settings to a Compose deployment.

Then click on the SSL tab and choose the SSL setting that you would like to use. The example shows setting MySQL Workbench to connect using SSL and to verify the server, so you will also need to save a copy of your deployment's self-signed certificate and provide its path.

Sample SSL settings for a Compose deploymentSample SSL settings for a Compose deployment

Sample SSL settings for a Compose deployment

Click on Test Connection to verify the settings, and Connect to connect and start MySQL Workbench.

Sequel Pro

Sequel Pro is a Mac app that provides a GUI for databases and tables and a wway to query them. To get started, downlaod the app from the Sequel Pro page and install it.

Opening it will take you to the Quick Connect screen. Enter in the information from the connection strings provided with your deployment. Ensure that the box for Connect Using SSL is checked, that you have saved local copy of the self-signed certificate for your deployment, and provided its path in the CA Cert field. For example:

Sample connection settings for a Compose for MySQL deploymentSample connection settings for a Compose for MySQL deployment

Sample connection settings for a Compose for MySQL deployment

Click on Test Connection to verify the settings, and Connect to connect and start Sequel Pro.

DBeaver

DBeaver is an open-source tool with a Community edition that supports SQL databases, including MySQL and PostgreSQL. There is also an Enterprise edition that supports NoSQL databases, including MongoDB and Redis. For Compose for MySQL the Community edition is sufficent and can be downloaded from their downloads page. Once installed you will want to set up a new connection with the connection strings provided with your deployment.

Sample connection settings for a Compose for MySQL deploymentSample connection settings for a Compose for MySQL deployment

Sample connection settings for a Compose for MySQL deployment

Click Next and also on the SSL tab. Be sure the checkbox next to Use SSL is checked, and provide a path to a local copy of the self-signed certficate for your deployment. You might also want to check the Require SSL and Verify server certificate settings as well.

Sample SSL settings for a Compose for MySQL deploymentSample SSL settings for a Compose for MySQL deployment

Sample SSL settings for a Compose for MySQL deployment

Click Next and the final screen provides you a place to name the connection and some other configuration options should you need them.

Click on Test Connection to verify the settings, and Finish to connect and start DBeaver.


Still Need Help?

If this article didn't solve things, summon a human and get some help!