VOOZH about

URL: https://www.cdata.com/kb/tech/mysql-jdbc-r.rst

⇱ Analyze MySQL Data in R via JDBC


Analyze MySQL Data in R via JDBC

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use standard R functions and the development environment of your choice to analyze MySQL data with the CData JDBC Driver for MySQL.

Access MySQL data with pure R script and standard SQL on any machine where R and Java can be installed. You can use the CData JDBC Driver for MySQL and the RJDBC package to work with remote MySQL data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to MySQL and visualize MySQL data by calling standard R functions.

Install R

You can match the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running open R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open 3.2.3, which is preconfigured to install packages from the Jan. 1, 2016 snapshot of the CRAN repository. This snapshot ensures reproducibility.

Load the RJDBC Package

To use the driver, download the RJDBC package. After installing the RJDBC package, the following line loads the package:

library(RJDBC)

Connect to MySQL as a JDBC Data Source

You will need the following information to connect to MySQL as a JDBC data source:

  • Driver Class: Set this to cdata.jdbc.mysql.MySQLDriver
  • Classpath: Set this to the location of the driver JAR. By default this is the lib subfolder of the installation folder.

The DBI functions, such as dbConnect and dbSendQuery, provide a unified interface for writing data access code in R. Use the following line to initialize a DBI driver that can make JDBC requests to the CData JDBC Driver for MySQL:

driver <- JDBC(driverClass = "cdata.jdbc.mysql.MySQLDriver", classPath = "MyInstallationDir\lib\cdata.jdbc.mysql.jar", identifier.quote = "'") 

You can now use DBI functions to connect to MySQL and execute SQL queries. Initialize the JDBC connection with the dbConnect function.

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.)

Below is a sample dbConnect call, including a typical JDBC connection string:

conn <- dbConnect(driver,"jdbc:mysql:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;")

Schema Discovery

The driver models MySQL APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:

dbListTables(conn)

Execute SQL Queries

You can use the dbGetQuery function to execute any SQL query supported by the MySQL API:

orders <- dbGetQuery(conn,"SELECT ShipName, Freight FROM Orders")

You can view the results in a data viewer window with the following command:

View(orders)

Plot MySQL Data

You can now analyze MySQL data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:

par(las=2,ps=10,mar=c(5,15,4,2))
barplot(orders$Freight, main="MySQL Orders", names.arg = orders$ShipName, horiz=TRUE)
👁 A basic bar plot. (Salesforce is shown.)