pacphi / PivotalMySQLWeb

PivotalMySQL*Web is a free Pivotal open source project, intended to handle the administration of a Pivotal MySQL Service Instance over the Web

PivotalMySQLWeb is a free Pivotal open source project, intended to handle the administration of a Pivotal MySQL Service Instance over the Web. PivotalMySQLWeb supports a wide range of operations on a Pivotal MySQL Service Instance such as managing tables, views, indexes which can all be performed via the user interface, while you still have the ability to directly execute any number of SQL statements

It includes the following capabilities :

• Multiple Command SQL worksheet for DDL and DML
• Run Explain Plan across SQL Statements
• View/Run DDL command against Tables/Views/Indexes/Constraints
• Command History
• Auto Bind to Pivotal MySQL Services bound to the Application within Pivotal Cloud Foundry (PCF)
• Manage JDBC Connections
• Load SQL File into SQL Worksheet from Local File System
• SQL Worksheet with syntax highlighting support
• HTTP GET request to auto login without a login form
• Export SQL query results in JSON or CSV formats

Run stand alone outside of PCF

• $ git clone https://github.com/pivotal-cf/PivotalMySQLWeb.git
• $ cd PivotalMySQLWeb
• $ ./mvnw -DskipTests=true package
• Run as follows "java -jar ./target/PivotalMySQLWeb-1.0.0-SNAPSHOT.jar"

Note: If you opt-in to running tests, you must have Docker installed. We employ the MySQL container from testcontainers.org library.

papicella@papicella:~/pivotal/DemoProjects/spring-starter/pivotal/PivotalMySQLWeb$ java -jar ./target/PivotalMySQLWeb-1.0.0-SNAPSHOT.jar

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.1.0.RELEASE)

...

2016-07-03 17:13:44.164  INFO 19664 --- [           main] .m.m.a.ExceptionHandlerExceptionResolver : Detected @ExceptionHandler methods in repositoryRestExceptionHandler
2016-07-03 17:13:44.225  INFO 19664 --- [           main] o.s.j.e.a.AnnotationMBeanExporter        : Registering beans for JMX exposure on startup
2016-07-03 17:13:44.291  INFO 19664 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http)
2016-07-03 17:13:44.294  INFO 19664 --- [           main] c.p.p.m.PivotalMySqlWebApplication       : Started PivotalMySqlWebApplication in 3.4 seconds (JVM running for 3.761)

• Access as follows and connect to your MySQL instance using the default username/password as follows:

Default username = admin
Default password = cfmysqlweb

http://localhost:8080/

Note: When connecting to a MySQL database instance ensure you JDBC URL includes a database name as shown below which e.g., targets the "employees" database

jdbc:mysql://localhost:3306/employees

Deploy to Pivotal Cloud Foundry

To deploy to Pivotal Cloud Foundry it's best to bind the application to a Pivotal MySQL service instance so it automatically connects to the MySQL instance as shown in the sample manifest below. If you don't bind to a MySQL instance it will simply ask you to login to a MySQL instance itself.

applications:
- name: pivotal-mysqlweb
  memory: 1024M
  instances: 1
  random-route: true
  path: ./target/PivotalMySQLWeb-1.0.0-SNAPSHOT.jar
  services:
    - some-mysql-database-instance
  env:
    JAVA_OPTS: -Djava.security.egd=file:///dev/urandom

Push to PCF using

$ cf push -f manifest.yml

Screen Shots

SQL Worksheet - Max Records to Display

You can control the number of records to display in the "SQL Worksheet" using the "Preferences" page. To do that follow these steps:

1. On the top menu bar select "Menu -> Preferences"
2. Set the value for "Max Records in Worksheet" to the value you require it should be more then 30 by default unless it was changed prior to deployment
3. Click "Update Preferences"

Alternatively you can also set that at deployment to use a default value by editing "main/resources/preferences.properties" and setting the property below.

maxRecordsinSQLQueryWindow=500

Security - HTTP Basic Authentication

By default this application is using HTTP Basic Authentication to protect every end point. The username/password is set in "main/resources/application-cloud.yml" and "main/resources/application.yml" files and can be altered here prior to deploying. Be sure to repackage to pick up your new username/password you wish to use for HTTP Basic Authentication

Default username = admin
Default password = cfmysqlweb

spring:
  security:
    user:
      name: admin
      password: cfmysqlweb

---

Pas Apicella [papicella at pivotal.io] is an Advisory Platform Architect at Pivotal Australia