Connect to MySQL Data in Aqua Data Studio

The CData JDBC Driver for MySQL integrates MySQL data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to MySQL data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The MySQL data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, MySQL.
   • Driver Location: Click the Browse button and select the cdata.jdbc.mysql.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.mysql.MySQLDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:mysql: and is followed by a semicolon-separated list of connection properties.

     The CData Provider supports connecting to on-premises and cloud-hosted versions of MySQL such as Amazon RDS for MySQL, Google Cloud SQL for MySQL, Azure Database for MySQL, or Oracle MySQL HeatWave. The Server and Port properties must be set to a MySQL server. If IntegratedSecurity is set to false, then User and Password must be set to valid user credentials. Optionally, Database can be set to connect to a specific database. If not set, tables from all databases will be returned.

     SSH Connectivity for MySQL

     You can use SSH (Secure Shell) to authenticate with MySQL, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).

     SSH Connections to MySQL in Password Auth Mode

     To connect to MySQL via SSH in Password Auth mode, set the following connection properties:

     • User: MySQL User name
     • Password: MySQL Password
     • Database: MySQL database name
     • Server: MySQL Server name
     • Port: MySQL port number like 3306
     • UserSSH: "true"
     • SSHAuthMode: "Password"
     • SSHPort: SSH Port number
     • SSHServer: SSH Server name
     • SSHUser: SSH User name
     • SSHPassword: SSH Password

     SSH Connections to MySQL in Public Key Auth Mode

     To connect to MySQL via SSH in Password Auth mode, set the following connection properties:

     • User: MySQL User name
     • Password: MySQL Password
     • Database: MySQL database name
     • Server: MySQL Server name
     • Port: MySQL port number like 3306
     • UserSSH: "true"
     • SSHAuthMode: "Public_Key"
     • SSHPort: SSH Port number
     • SSHServer: SSH Server name
     • SSHUser: SSH User name
     • SSHClientCret: the path for the public key certificate file

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the MySQL JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.mysql.jar
     

     Fill in the connection properties and copy the connection string to the clipboard.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     A typical JDBC URL is below:

     jdbc:mysql:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query MySQL Data

You can now query the tables exposed.