Create a Data Access Object for MariaDB Data using JDBI

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for MariaDB integrates connectivity to live MariaDB data in Java applications. By pairing these technologies, you gain simple, programmatic access to MariaDB data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read and write MariaDB data.

Create a DAO for the MariaDB Orders Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyOrdersDAO {
 //insert new data into MariaDB
 @SqlUpdate("INSERT INTO Orders (ShipCountry, ShipCity) values (:shipCountry, :shipCity)")
 void insert(@Bind("shipCountry") String shipCountry, @Bind("shipCity") String shipCity);

 //request specific data from MariaDB (String type is used for simplicity)
 @SqlQuery("SELECT ShipCity FROM Orders WHERE ShipCountry = :shipCountry")
 String findShipCityByShipCountry(@Bind("shipCountry") String shipCountry);

 /*
 * close with no args is used to close the connection
 */
 void close();
}

Open a Connection to MariaDB

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to MariaDB.

The Server and Port properties must be set to a MariaDB 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, the tables from all databases are reported.

Built-in Connection String Designer

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

java -jar cdata.jdbc.mariadb.jar

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

A connection string for MariaDB will typically look like the following:

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

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:mariadb:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;");
MyOrdersDAO dao = dbi.open(MyOrdersDAO.class);

//do stuff with the DAO

dao.close();

Read MariaDB Data

With the connection open to MariaDB, simply call the previously defined method to retrieve data from the Orders entity in MariaDB.

//disply the result of our 'find' method
String shipCity = dao.findShipCityByShipCountry("USA");
System.out.println(shipCity);

Write MariaDB Data

It is also simple to write data to MariaDB, using the previously defined method.

//add a new entry to the Orders entity
dao.insert(newShipCountry, newShipCity);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for MariaDB by integrating with the CData JDBC Driver for MariaDB. Download a free trial and work with live MariaDB data in custom Java applications today.