How to connect to a MySQL database

You will want to connect to your MySQL database for two reasons: 

  • Reason 1: To retrieve data from the database while generating data using GenRocket runtime using generators like ListQueryGen, QueryBeforeLoop, etc.

  • Reason 2: To populate tables in the database using receivers like GenericSQLInsertReceiver, MySQLInsertReceiver, etc.


To use these Generators and Receivers, GenRocket leverages JDBC.


In This Article


What is JDBC?

JDBC stands for Java™ database connectivity (JDBC) and is the JavaSoft specification of a standard application programming interface (API) that allows Java programs to access database management systems. GenRocket can connect to any database that supports JDBC. 


Connection Steps 

Step 1 - Create a JDBC Configuration Properties File

For GenRocket to connect to a database via JDBC you will need to create a config.properties file. An application can connect a SQL database via JDBC by reading a JDBC properties file that contains the following information:

  • driver - Defines the name of the specific database driver to use to access the given database.  The actual driver file must be placed in the $GEN_ROCKET_HOME/lib folder on your local computer.
  • user - Defines the Username used to access the database.
  • password - Defines the password used to access the database.
  • url - Defines the specific URL to access the database.
  • batchCount - Defines the number of SQL statements that are batched together and sent to the database for execution. This property is only mandatory for GenRocket Receivers.

   driver=<JDBCDriverClassName>
   user=<userToConnectToDatabase>
   password=<passwordToConnectToDatabase>
   url=<URL>/<databaseName>
   batchCount=1000


Example config.properties for MySQL database

GenRocket will read this config file and connect to an employee database on localhost using username root and password root. If you are connecting to a different type of database, your configuration file will look different. 


driver=com.mysql.jdbc.Driver
user=root
password=root
url=jdbc:mysql://localhost:3306/employee?rewriteBatchedStatements=true
batchCount=1000


Step 2 - Enter a valid value for the resource.jdbc.config Organization Resource in GenRocket

The resource.jdbc.config Organization Resource specifies the location of the JDBC config.property file on the logged in user's local machine. For more information about Organization Resources, click here.

This resource value should contain the full directory path (e.g., /home/user/dev)


Linux/Mac OSX Example


Windows Example


Step 3 - Update your Profile in the .genrocket Folder

Each user has their own Profile that is stored in the .genrocket folder on their local machine. You will need to download and replace your profile (in ~/.genrocket folder) any time the following changes are made: 

  • Resource value(s) are updated
  • A new resource is added
  • A resource is removed


GenRocket will read this resource value from your profile on your system to make a connection with the database. 


Step 4 - Download and place the JDBC connector Jar file in the $GENROCKET_HOME/lib/ folder

Step 5 - Reference the JDBC Resource in your Generators or Receivers

When you create a scenario containing a Generator or Receiver that references your jdbc.config resource, it will connect directly to your database. 


Troubleshooting

Error: Access denied for user 'root'@'localhost'

When running the script in the command line, the above error may occur. GenRocket Runtime is trying to make the connection with the MySQL server, but MySQL is not allowing access for the user "root".

If the password for the root user is not set, then you can set the password. Be sure to update it within the config.properties file before trying again.