Using Management Tools for MySQL for Pivotal Platform

Page last updated:

This topic provides instructions for tools developers can use to access their MySQL for Pivotal Platform databases.

Overview

You can access your MySQL for Pivotal Platform databases by using the following tools:

Pivotal MySQLWeb Database Management App

The Pivotal MySQLWeb app provides a web-based UI for managing MySQL for Pivotal Platform databases. The free app lets you view and operate on tables, indexes, constraints, and other database structures, and directly execute SQL commands.

Pivotal MySQLWeb

You can run the Pivotal MySQLWeb app in two ways:

  • Standalone on your own machine
  • Deployed to Pivotal Platform

If you deploy Pivotal MySQLWeb to Pivotal Platform, you can configure it in the deployment manifest to automatically bind to a specific service instance.

See the Pivotal MySQLWeb code repo and demo video, for how to install and run Pivotal MySQLWeb.

cf CLI MySQL Plugin

To connect to your MySQL for Pivotal Platform databases from a command line, use the cf CLI MySQL plugin. The plugin lets you:

  • Inspect databases for debugging
  • Manually adjust database schema or contents in development environments
  • Dump and restore databases

To install the cf CLI MySQL plugin, run the following:

$ cf install-plugin -r "CF-Community" mysql-plugin

For more information, see the cf-mysql-plugin repository.

Desktop Tools

You can connect your MySQL for Pivotal Platform databases to a desktop tool, such as MySQL Workbench or Sequel Pro, if you have the credentials for your MySQL service instance.

If you do not have credentials for your MySQL service instance, follow the procedure in Create Read-only Access Credentials.

To connect your databases to a desktop tool do the following:

  1. To retrieve the credentials from your MySQL service instance service key, run the following command:

    cf service-key SERVICE-INSTANCE MYSQL-SERVICE-KEY
    

    Where:

    • SERVICE-INSTANCE is the name of your service instance.
    • KEY-NAME is the name of your service key.

    For example:

      $ cf service-key mydb mykey1
    { "hostname": "q-n3s3y1.q-g693.bosh", "jdbcUrl": "jdbc:mysql://q-n3s3y1.q-g693.bosh:3306/service_instance_db?user=6bf07ae455a14064a9073cec8696366c\u0026password=a22aaa2a2a2aaaaa\u0026=true", "name": "service\_instance\_db", "password": "a22aaa2a2a2aaaaa", "port": 3306, "uri": "mysql://6bf07ae455a14064a9073cec8696366c:a22aaa2a2a2aaaaa@q-n3s3y1.q-g693.bosh:3306/service_instance_db?reconnect=true", "username": "6bf07ae455a14064a9073cec8696366c" }
  2. Record the values for the following:

    • hostname
    • name
    • password
    • port
    • username
  3. Configure an SSH tunnel using the values for hostname and port that you recorded in the above step. For information on configuring an SSH tunnel, see Configure Your SSH Tunnel.

  4. Configure a connection in your desktop tool using the values for hostname, name, password, port, and username that you recorded in the above step.