Create a Data Access Object for SingleStore 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 SingleStore integrates connectivity to live SingleStore data in Java applications. By pairing these technologies, you gain simple, programmatic access to SingleStore data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read and write SingleStore data.

Create a DAO for the SingleStore 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 SingleStore
 @SqlUpdate("INSERT INTO Orders (ShipCountry, ShipCity) values (:shipCountry, :shipCity)")
 void insert(@Bind("shipCountry") String shipCountry, @Bind("shipCity") String shipCity);

 //request specific data from SingleStore (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 SingleStore

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

The following connection properties are required in order to connect to data.

• Server: The host name or IP of the server hosting the SingleStore database.
• Port: The port of the server hosting the SingleStore database.
• Database (Optional): The default database to connect to when connecting to the SingleStore Server. If this is not set, tables from all databases will be returned.

Connect Using Standard Authentication

To authenticate using standard authentication, set the following:

• User: The user which will be used to authenticate with the SingleStore server.
• Password: The password which will be used to authenticate with the SingleStore server.

Connect Using Integrated Security

As an alternative to providing the standard username and password, you can set IntegratedSecurity to True to authenticate trusted users to the server via Windows Authentication.

Connect Using SSL Authentication

You can leverage SSL authentication to connect to SingleStore data via a secure session. Configure the following connection properties to connect to data:

• SSLClientCert: Set this to the name of the certificate store for the client certificate. Used in the case of 2-way SSL, where truststore and keystore are kept on both the client and server machines.
• SSLClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
• SSLClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
• SSLClientCertType: The certificate type of the client store.
• SSLServerCert: The certificate to be accepted from the server.

Connect Using SSH Authentication

Using SSH, you can securely login to a remote machine. To access SingleStore data via SSH, configure the following connection properties:

• SSHClientCert: Set this to the name of the certificate store for the client certificate.
• SSHClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
• SSHClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
• SSHClientCertType: The certificate type of the client store.
• SSHPassword: The password that you use to authenticate with the SSH server.
• SSHPort: The port used for SSH operations.
• SSHServer: The SSH authentication server you are trying to authenticate against.
• SSHServerFingerPrint: The SSH Server fingerprint used for verification of the host you are connecting to.
• SSHUser: Set this to the username that you use to authenticate with the SSH server.

Built-in Connection String Designer

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

java -jar cdata.jdbc.singlestore.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 connection string for SingleStore will typically look like the following:

jdbc:singlestore: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:singlestore:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;");
MyOrdersDAO dao = dbi.open(MyOrdersDAO.class);

//do stuff with the DAO

dao.close();

Read SingleStore Data

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

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

Write SingleStore Data

It is also simple to write data to SingleStore, 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 SingleStore by integrating with the CData JDBC Driver for SingleStore. Download a free trial and work with live SingleStore data in custom Java applications today.