Skip to content

Querying a MySQL Database

Ballerina is an open-source programming language that empowers developers to integrate their system easily with the support of connectors. In this guide, we are mainly focusing on how to expose MySQL database as a service in Ballerina and do a select query upon it.

ballerinax/java.jdbc module allows you to perform CRUD operations using JDBC Client. You can find other integration modules from the wso2-ballerina Github repository.

What you'll build

Here the caller will send the last name of the employee for whom he wants to fetch the first name as a path parameter. Then the select query will be performed on the MySQL database and the results will be returned.

querying mysql database

Before you begin

  • Download and install Ballerina Integrator for your operating system

    Note: This installs Ballerina language version 1.0.1, a compiler plugin to help mitigate errors, and snippet .jar files for custom auto-completion.

  • Install Oracle JDK 1.8.*
  • Install VS Code

    Tip: For a better development experience, use VS Code (which is the recommended editor for Ballerina Integrator).

  • Install the Ballerina Integrator Extension from the VS Code marketplace
  • Download MySQL JDBC driver

Get the code

You can download the ZIP file and extract the contents to get the project code.

Download ZIP


The Ballerina project is created for the integration use case explained above. Please follow the steps given below. You can learn about the Ballerina project and module by following the documentation on creating a project and using modules.

Create a project.

$ ballerina new querying-mysql-database
Navigate to the querying-mysql-database directory.

Add a module.

$ ballerina add querying_mysql_database

Create a folder called lib under the project root path. Copy the JDBC driver for MySQL into the lib folder.

The project structure should look like below.

├── querying-mysql-database
    ├── lib
        └── mysql-connector-java-8.0.17.jar
    ├── ballerina.conf    
    ├── Ballerina.toml
    └── src
        └── querying_mysql_database
            ├── main.bal
            ├── resources
            └── tests
                └── resources

Add the following under the [dependencies] section in Ballerina.toml file in the root directory of the project.

target = "java8"

module = "querying_mysql_database"
path = "./lib/mysql-connector-java-8.0.17.jar"
Run the sampleScript.sql script inside resources folder to create the table and insert data required for the guide.

  • ballerina.conf file can be used to provide external configurations to Ballerina programs. Since this guide needs MySQL database integration, a Ballerina configuration file is used to provide the database connection properties to our Ballerina program. This configuration file has the following fields. Change these configurations with your connection properties accordingly.

    DATABASE_URL = "jdbc:mysql://"

Write your integration.

You can open the project with VS Code. The implementation will be written in the main.bal file.

import ballerina/config;
import ballerina/http;
import ballerina/jsonutils;
import ballerina/log;
import ballerinax/java.jdbc;

jdbc:Client employeeDB = new ({
    url: config:getAsString("MYSQL_URL"),
    username: config:getAsString("MYSQL_USERNAME"),
    password: config:getAsString("MYSQL_PASSWORD"),
    dbOptions: {useSSL: false}

listener http:Listener employeeEP = new (9095);

@http:ServiceConfig {
    basePath: "/staff"

service dbTransactions on employeeEP {
    @http:ResourceConfig {
        methods: ["GET"],
        path: "/employee/{lastName}"

    resource function getEmployees(http:Caller caller, http:Request request, string lastName) {
        http:Response response = new;
        log:printInfo("The select operation - Select data from a table");
        var selectResult = employeeDB->select("SELECT firstName FROM Employee WHERE lastName = ?", (), lastName);

        if (selectResult is table<record {}>) {
            json jsonConversionResult = jsonutils:fromTable(selectResult);
            response.statusCode = http:STATUS_OK;
        } else {
            log:printError("Error occurred in querying data");
            response.statusCode = http:STATUS_NOT_FOUND;
            json responseJson = {"Failed": selectResult.reason()};

        var result = caller->respond(response);

        if (result is error) {
            log:printError("Error sending response to the client", err = result);


First, let’s build the module. While being in the querying_mysql_db directory, execute the following command.

$ ballerina build querying_mysql_database

The build command would create an executable .jar file. Now run the .jar file created in the above step.

$ java -jar target/bin/querying_mysql_database.jar

Send the following request where the last name is set as a path param.

curl -X GET http://localhost:9095/staff/employee/collins -H 'Content-Type: application/json'

This will return the following response to the client if the request is successful.

[{"firstName":"thomas"}, {"firstName":"abner"}]